@acceleratxr/core_sdk / MessageService
Class: MessageService#
Hierarchy#
-
↳ MessageService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new MessageService(apiClient: ApiClient, config: Configuration): MessageService
Overrides ServiceBase.constructor
Defined in src/services/MessageService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: MessageService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “3ab36398-6458-4f6c-bb8f-a494469b6923”
Defined in src/services/MessageService.ts:17
Methods#
clearInbox#
▸ clearInbox(): Promise<void>
Defined in src/services/MessageService.ts:104
Deletes all messages sent to the logged in user.
Returns: Promise<void>
clearSent#
▸ clearSent(): Promise<void>
Defined in src/services/MessageService.ts:125
Deletes all messages sent by the logged in user.
Returns: Promise<void>
count#
▸ count(query?: any): Promise<number>
Defined in src/services/MessageService.ts:46
Returns the count of messages
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Message): Promise<Message | undefined>
Defined in src/services/MessageService.ts:34
Create a new message.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Message | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/MessageService.ts:78
Deletes the message
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Message[] | undefined>
Defined in src/services/MessageService.ts:22
Returns all messages from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Message[] | undefined>
findById#
▸ findById(id: string): Promise<Message | undefined>
Defined in src/services/MessageService.ts:65
Returns a single message from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Message | undefined>
findInbox#
▸ findInbox(): Promise<Message[] | undefined>
Defined in src/services/MessageService.ts:146
Returns all of the messages from the system that have been sent to the logged in user.
Returns: Promise<Message[] | undefined>
findSent#
▸ findSent(): Promise<Message[] | undefined>
Defined in src/services/MessageService.ts:167
Returns all of the messages from the system that have been sent by the logged in user.
Returns: Promise<Message[] | undefined>
markRead#
▸ markRead(id: string): Promise<void>
Defined in src/services/MessageService.ts:91
Marks the message with the given id as having been read by the user.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>