@sudoplatform/sudo-secure-communications
    Preparing search index...

    Interface SecureCommsClient

    interface SecureCommsClient {
        channels: ChannelsModule;
        directChats: DirectChatsModule;
        groups: GroupsModule;
        handles: HandlesModule;
        media: MediaModule;
        messaging: MessagingModule;
        notifications: NotificationsModule;
        security: SecurityModule;
        storage: StorageModule;
        isReady(handleId: HandleId): Promise<boolean>;
        reset(): Promise<void>;
        startSyncing(handleId: HandleId): Promise<void>;
        stopSyncing(handleId: HandleId): Promise<void>;
    }

    Implemented by

    Index

    Properties

    channels directChats groups handles media messaging notifications security storage

    Methods

    isReady reset startSyncing stopSyncing

    Properties

    channels: ChannelsModule

    Accessor for the Channels sub-module.

    directChats: DirectChatsModule

    Accessor for the Direct Chats sub-module.

    groups: GroupsModule

    Accessor for the Groups sub-module.

    handles: HandlesModule

    Accessor for the Handles sub-module.

    media: MediaModule

    Accessor for the Media sub-module.

    messaging: MessagingModule

    Accessor for the Messaging sub-module.

    notifications: NotificationsModule

    Accessor for the Notifications sub-module.

    security: SecurityModule

    Accessor for the Security sub-module.

    storage: StorageModule

    Accessor for the Storage sub-module.

    Methods

    • Check if the client has finished the initial sync and is ready for use.

      Parameters

      • handleId: HandleId

        Identifier of the handle owned by this client.

      Returns Promise<boolean>

      True if the client is ready for use, false if not.

    • Removes any cached data maintained by this client.

      Returns Promise<void>

    • Start syncing in the background for data updates.

      Can only be called after sign-in creation of a handle.

      Parameters

      • handleId: HandleId

        Identifier of the handle owned by this client.

      Returns Promise<void>

    • Stop syncing.

      Parameters

      • handleId: HandleId

        Identifier of the handle owned by this client.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods