Interface CreateMessageInput<CustomFields>

interface CreateMessageInput {
    category: string;
    content: string;
    customFields?: CustomFields;
    messageType: "private" | "channel";
    organizationId?: string;
    priority?: string;
    receiptId?: string;
    senderId?: string;
    senderType: string;
    title?: string;
    topicId: string;
    typeId: string;
}

Type Parameters

  • CustomFields = unknown

Properties

category content customFields? messageType organizationId? priority? receiptId? senderId? senderType title? topicId typeId

Properties

category

category: string

Category of the message. Arbitrary string depending upon application

content

content: string

Message body

Optional customFields

customFields?: CustomFields

Custom fields for the message

messageType

messageType: "private" | "channel"

Message type. Either a private message or made in a subscribable channel

Optional organizationId

organizationId?: string

Associated organization with the message (for supply side)

Optional priority

priority?: string

Priority of the message. Arbitrary string depending upon application

Optional receiptId

receiptId?: string

Receiver of the message. Only applicable for private type

Optional senderId

senderId?: string

Sender id of the message. Generally a user id

senderType

senderType: string

Sender type of the message. Generally 'normalUser', but may be an arbitrary value depending upon senderId's purpose

Optional title

title?: string

Message title

topicId

topicId: string

Topic ID for the message

typeId

typeId: string

Type ID for the message. Arbitrary string depending upon application

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc