Interface SmsSession

interface SmsSession {
    get emitter(): EventEmitter;
    get info(): SmsSessionInfo;
    deleteMessages(messageIds: string[]): Promise<void>;
    deleteSession(): Promise<void>;
    getMessages(): SmsMessage[];
    loadMoreMessages(fromMessage?: SmsMessage): Promise<SmsMessage[]>;
    markMessagesSeen(timestamp: number): Promise<void>;
    sendMessage(message: string, files?: FssFile[]): Promise<string>;
    syncSmsMessages(timestamp: number): any;
}

Index

Accessors

Methods

deleteMessages deleteSession getMessages loadMoreMessages markMessagesSeen sendMessage syncSmsMessages

Accessors

emitter

get emitter(): EventEmitter

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

Returns EventEmitter

info

get info(): SmsSessionInfo

Get sms session info.

Returns SmsSessionInfo

Methods

deleteMessages

deleteMessages(messageIds: string[]): Promise<void>
Delete sms messages.
Parameters
- messageIds: string[]
  array of message ids to delete.
Returns Promise<void>

deleteSession

deleteSession(): Promise<void>

Delete session.

Returns Promise<void>

getMessages

getMessages(): SmsMessage[]

Get sms messages.

Returns SmsMessage[]

loadMoreMessages

loadMoreMessages(fromMessage?: SmsMessage): Promise<SmsMessage[]>
Load more messages before given message.
Parameters
- OptionalfromMessage: SmsMessage
  message from which timestamp messages should be loaded.
Returns Promise<SmsMessage[]>

markMessagesSeen

markMessagesSeen(timestamp: number): Promise<void>
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: string, files?: FssFile[]): Promise<string>
Send sms message.
Parameters
- message: string
  message text.
- Optionalfiles: FssFile[]
  message files for MMS.
Returns Promise<string>

syncSmsMessages

syncSmsMessages(timestamp: number): any
Sync messages.
Parameters
- timestamp: number
  timestamp of when the last sync of messages happened
Returns any