@acrobits/ipc-sdk 0.1.8 → 0.2.1-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -12,6 +12,10 @@ export declare interface BaseContactItem {
12
12
  * Cloud ID associated with the contact.
13
13
  */
14
14
  cloudId: string;
15
+ /**
16
+ * Network ID for the contact.
17
+ */
18
+ networkId: string;
15
19
  }
16
20
 
17
21
  /**
@@ -84,6 +88,10 @@ export declare interface DetailedContactItem {
84
88
  * Cloud username associated with the contact.
85
89
  */
86
90
  cloudUsername: string;
91
+ /**
92
+ * Network ID for the contact.
93
+ */
94
+ networkId: string;
87
95
  /**
88
96
  * URI or number associated with the contact with prefix (e.g. sip: or tel:)
89
97
  */
@@ -212,11 +220,13 @@ export declare class IPCManager {
212
220
  *
213
221
  * @param corelationId - An identifier for the message stream
214
222
  * @param mode - _Optional_. Whether to allow `single` or `multi` contact selection.
223
+ * @param contactType - _Optional_. The type of contacts to be selected. This can be either
224
+ * `cloudUsername` or `uri`. Defaults to `cloudUsername`.
215
225
  *
216
226
  * @returns A collection of {@link ContactItem} objects which the user selected along with the
217
227
  * `corelationId`.
218
228
  */
219
- selectContacts(corelationId: number, mode?: 'single'): Promise<ContactItem[]>;
229
+ selectContacts(corelationId: number, mode?: 'single', contactType?: ContactType): Promise<ContactItem[]>;
220
230
  /**
221
231
  * Requests the `Host` app to open the contact selection UI.
222
232
  *
@@ -231,11 +241,13 @@ export declare class IPCManager {
231
241
  * @param mode - Whether to allow `single` or `multi` contact selection.
232
242
  * @param currentContacts - A list of {@link ContactItem} objects that are currently selected.
233
243
  * This is used to highlight the current contacts from the selection UI.
244
+ * @param contactType - _Optional_. The type of contacts to be selected. This can be either
245
+ * `cloudUsername` or `uri`. Defaults to `cloudUsername`.
234
246
  *
235
247
  * @returns A collection of {@link ContactItem} objects which the user selected along with the
236
248
  * `corelationId`.
237
249
  */
238
- selectContacts(streamId: number, mode: 'multi', currentContacts: ContactItem[]): Promise<ContactItem[]>;
250
+ selectContacts(corelationId: number, mode: 'multi', currentContacts: ContactItem[], contactType?: ContactType): Promise<ContactItem[]>;
239
251
  /**
240
252
  * Matches batch of {@link ContactItem} objects against the Host's contact list to fetch detailed
241
253
  * contact information.