Skip to content

Module: client/apis/PrivateMessagesAPI

Table of contents

Classes

Type aliases

Type aliases

ArchiveMessages

Ƭ ArchiveMessages: object

Type declaration:

Name Type
failedMessages? { errorMessage: string ; messageId: number }[]

Defined in: client/apis/PrivateMessagesAPI.ts:63


ArchiveMessagesOptions

Ƭ ArchiveMessagesOptions: object

Type declaration:

Name Type
messageIds number[]

Defined in: client/apis/PrivateMessagesAPI.ts:60


GetAnnouncements

Ƭ GetAnnouncements: object

Type declaration:

Name Type
collection object
collection.body string
collection.created string
collection.id number
collection.sender object
collection.sender.displayName string
collection.sender.id number
collection.sender.name string
collection.subject string
collection.updated string
totalCollectionSize number

Defined in: client/apis/PrivateMessagesAPI.ts:5


GetAnnouncementsMetaData

Ƭ GetAnnouncementsMetaData: object

Type declaration:

Name Type
numOfAnnouncements number

Defined in: client/apis/PrivateMessagesAPI.ts:20


GetMessage

Ƭ GetMessage: GetMessages[collection][0]

Defined in: client/apis/PrivateMessagesAPI.ts:56


GetMessageOptions

Ƭ GetMessageOptions: object

Type declaration:

Name Type
messageId number

Defined in: client/apis/PrivateMessagesAPI.ts:53


GetMessages

Ƭ GetMessages: object

Type declaration:

Name Type
collection { body: string ; created: string ; id: number ; isRead: boolean ; isReportAbuseDisplayed: boolean ; isSystemMessage: boolean ; recipient: { displayName: string ; id: number ; name: string } ; sender: { displayName: string ; id: number ; name: string } ; subject: string ; updated: string }[]
pageNumber number
totalCollectionSize number
totalPages number

Defined in: client/apis/PrivateMessagesAPI.ts:28


GetMessagesOptions

Ƭ GetMessagesOptions: object

Type declaration:

Name Type
messageTab? Inbox | Sent | Archive
pageNumber? number
pageSize? number

Defined in: client/apis/PrivateMessagesAPI.ts:23


GetUnreadMessagesCount

Ƭ GetUnreadMessagesCount: object

Type declaration:

Name Type
count number

Defined in: client/apis/PrivateMessagesAPI.ts:57


MarkMessagesRead

Ƭ MarkMessagesRead: ArchiveMessages

Defined in: client/apis/PrivateMessagesAPI.ts:70


MarkMessagesReadOptions

Ƭ MarkMessagesReadOptions: ArchiveMessagesOptions

Defined in: client/apis/PrivateMessagesAPI.ts:69


MarkMessagesUnread

Ƭ MarkMessagesUnread: ArchiveMessages

Defined in: client/apis/PrivateMessagesAPI.ts:72


MarkMessagesUnreadOptions

Ƭ MarkMessagesUnreadOptions: ArchiveMessagesOptions

Defined in: client/apis/PrivateMessagesAPI.ts:71


SendMessage

Ƭ SendMessage: object

Type declaration:

Name Type
message string
shortMessage string
success boolean

Defined in: client/apis/PrivateMessagesAPI.ts:81


SendMessageOptions

Ƭ SendMessageOptions: object

Type declaration:

Name Type
body string
includePreviousMessage? boolean
recipientId number
replyMessageId? number
subject string
userId number

Defined in: client/apis/PrivateMessagesAPI.ts:73


UnArchiveMessages

Ƭ UnArchiveMessages: ArchiveMessages

Defined in: client/apis/PrivateMessagesAPI.ts:87


UnArchiveMessagesOptions

Ƭ UnArchiveMessagesOptions: ArchiveMessagesOptions

Defined in: client/apis/PrivateMessagesAPI.ts:86