Skip to content

Contacts services ​

C# signatures use the types and conventions in Integration. CancellationToken controls the client call. Command objects include inherited fields from ApiCommand where applicable.

IContacts ​

List the caller's chats and places, manage contact entries, and block contacts. Source

csharp
Task<Contact?> Get(
    Session session,
    ContactId contactId,
    CancellationToken cancellationToken
);
csharp
Task<Contact?> GetForChat(
    Session session,
    ChatId chatId,
    CancellationToken cancellationToken
);
csharp
Task<ContactId[]> ListIds(
    Session session,
    PlaceId? placeId,
    CancellationToken cancellationToken
);
csharp
Task<PlaceId[]> ListPlaceIds(
    Session session,
    CancellationToken cancellationToken
);
csharp
Task<ContactId[]> ListBlockedIds(
    Session session,
    CancellationToken cancellationToken
);
csharp
Task<Contact?> OnChange(
    Contacts_Change command,
    CancellationToken cancellationToken
);
csharp
Task OnTouch(
    Contacts_Touch command,
    CancellationToken cancellationToken
);
csharp
Task OnSetIsBlocked(
    Contacts_SetIsBlocked command,
    CancellationToken cancellationToken
);

Related data: ChatId, Contact, ContactId, Contacts_Change, Contacts_SetIsBlocked, Contacts_Touch, PlaceId.

IExternalContactHashes ​

Read and update a device address-book synchronization hash. Source

csharp
Task<ExternalContactsHash?> Get(
    Session session,
    Symbol deviceId,
    CancellationToken cancellationToken
);
csharp
Task<ExternalContactsHash?> OnChange(
    ExternalContactHashes_Change command,
    CancellationToken cancellationToken
);

Related data: ExternalContactHashes_Change, ExternalContactsHash.

IExternalContacts ​

Synchronize device address-book records in batches. Source

csharp
Task<ExternalContact[]> List(
    Session session,
    Symbol deviceId,
    CancellationToken cancellationToken
);
csharp
Task<Result<ExternalContactFull?>[]> OnBulkChange(
    ExternalContacts_BulkChange command,
    CancellationToken cancellationToken
);

Related data: ExternalContact, ExternalContactFull, ExternalContacts_BulkChange.