foundation-comms.messagebuilder

Home > @genesislcap/foundation-comms > MessageBuilder

MessageBuilder interface

A utility class for building different types of messages.

Signature:

export interface MessageBuilder 

Methods

Method	Description
createChangePasswordMessage(username, oldPassword, newPassword)	Creates a change password message.
createCommitMessage(eventName, params)	Creates an event commit message.
createDataLogoffMessage(sourceRef)	Creates a message to logoff from a DATASERVER.
createDataLogonMessage(resourceName, params)	Creates a message to logon to a DATASERVER. Used for data fetching.
createForgotPasswordMessage(username, returnUrl, requester)	Creates a forgot password message.
createForgotPasswordTokenMessage(username, resetToken, newPassword, requester)	Creates a forgot password token message.
createHeartbeatPingMessage(verbose)
createHTTPHeadersFromMessage(message, contentType)	Create HTTP Headers from a message.
createLoginMessage(credentials)	Creates a login message.
createLogoutMessage(loginResult)	Creates a logout message.
createMetaRequestMessage(resourceName, messageType)	Creates a metadata fetch message.
createMoreColumnsMessage(sourceRef)	Creates a message to request more columns.
createMoreRowsMessage(sourceRef, viewNumber)	Creates a message to request more rows. This is only relevant when you are connected to a real-time (Data Server) datasource.
createRefreshTokenMessage()	Creates an auth message specific for token refresh.
createRequestMessage(resourceName, params)	Creates a request message.
createResourcesMessage(params)	Creates a message for getting list of resources.