io.appium.settings
Version:
App for dealing with Android settings
90 lines • 2.23 kB
TypeScript
/**
* @typedef {Object} SmsListOptions
* @property {number} [max=100] - The maximum count of recent messages
* to retrieve
*/
/**
* @typedef SmsListResult
* @property {SmsListResultItem[]} items
* @property {number} total
*/
/**
* @privateRemarks XXX: WAG
* @typedef SmsListResultItem
* @property {string} id
* @property {string} address
* @property {string|null} person
* @property {string} date
* @property {string} read
* @property {string} status
* @property {string} type
* @property {string|null} subject
* @property {string} body
* @property {string|null} serviceCenter
*/
/**
* Retrieves the list of the most recent SMS
* properties list via Appium Settings helper.
* Messages are sorted by date in descending order.
*
* @this {import('../client').SettingsApp}
* @param {SmsListOptions} opts
* @returns {Promise<SmsListResult>} The example output is:
* ```json
* {
* "items":[
* {
* "id":"2",
* "address":"+123456789",
* "person":null,
* "date":"1581936422203",
* "read":"0",
* "status":"-1",
* "type":"1",
* "subject":null,
* "body":"\"text message2\"",
* "serviceCenter":null
* },
* {
* "id":"1",
* "address":"+123456789",
* "person":null,
* "date":"1581936382740",
* "read":"0",
* "status":"-1",
* "type":"1",
* "subject":null,
* "body":"\"text message\"",
* "serviceCenter":null
* }
* ],
* "total":2
* }
* ```
* @throws {Error} If there was an error while getting the SMS list
*/
export function getSmsList(this: import("../client").SettingsApp, opts?: SmsListOptions): Promise<SmsListResult>;
export type SmsListOptions = {
/**
* - The maximum count of recent messages
* to retrieve
*/
max?: number | undefined;
};
export type SmsListResult = {
items: SmsListResultItem[];
total: number;
};
export type SmsListResultItem = {
id: string;
address: string;
person: string | null;
date: string;
read: string;
status: string;
type: string;
subject: string | null;
body: string;
serviceCenter: string | null;
};
//# sourceMappingURL=sms.d.ts.map