Skip to main content
Version: v8.2

Interface: SmsSession

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:4

Accessors​

emitter​

Get Signature​

get emitter(): EventEmitter

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:59

Get event emitter. All SmsEvents related to session will be posted on this emmiter.

Returns​

EventEmitter


info​

Get Signature​

get info(): SmsSessionInfo

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:54

Get sms session info.

Returns​

SmsSessionInfo

Methods​

deleteMessages()​

deleteMessages(messageIds): Promise<void>

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:35

Delete sms messages.

Parameters​

messageIds​

string[]

array of message ids to delete.

Returns​

Promise<void>


deleteSession()​

deleteSession(): Promise<void>

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:28

Delete session.

Returns​

Promise<void>


getMessages()​

getMessages(): SmsMessage[]

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:16

Get sms messages.

Returns​

SmsMessage[]


loadMoreMessages()​

loadMoreMessages(fromMessage?): Promise<SmsMessage[]>

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:49

Load more messages before given message.

Parameters​

fromMessage?​

SmsMessage

message from which timestamp messages should be loaded.

Returns​

Promise<SmsMessage[]>


markMessagesSeen()​

markMessagesSeen(timestamp): Promise<void>

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:23

Mark all messages before given timestamp as seen.

Parameters​

timestamp​

number

timestamp of the last message that wants to be marked as seen.

Returns​

Promise<void>


sendMessage()​

sendMessage(message, files?): Promise<string>

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:11

Send sms message.

Parameters​

message​

string

message text.

files?​

FssFile[]

message files for MMS.

Returns​

Promise<string>


syncSmsMessages()​

syncSmsMessages(timestamp): any

Defined in: sdk/.repo/sdk/src/interfaces/sms/Session.ts:42

Sync messages.

Parameters​

timestamp​

number

timestamp of when the last sync of messages happened

Returns​

any