@zelloptt/react-native-zello-sdk
    Preparing search index...

    Interface Spec

    Codegen spec for the unified Zello TurboModule.

    This single spec replaces the legacy, platform-divergent ZelloIOSSdkModule and ZelloAndroidSdkModule bridge modules. Both platforms implement the same interface. Events are not part of this spec: they are emitted on the global DeviceEventEmitter 'zellosdk' channel and carry an eventName discriminator in their payload (see src/events).

    Codegen notes:

    • configure takes a single object so the platform-specific configuration fields (ios.isDebugBuild, ios.appGroup, android.enableOfflineMessagePushNotifications, android.enableForegroundService) can live in one signature.
    • The two legacy callback methods (getHistory, getHistoryImageData) are modeled as Promises, which is the TurboModule-native async shape.
    • UnsafeObject is used where the payload is a heterogeneous SDK structure that is normalized in the JS layer (src/sdk).
    interface Spec {
        addUsersToGroupConversation(
            conversationName: string,
            usernames: string[],
        ): void;
        configure(config: object): void;
        connect(network: string, username: string, password: string): void;
        connectChannel(name: string): void;
        connectGroupConversation(name: string): void;
        createGroupConversation(usernames: string[], displayName: string): void;
        disconnect(): void;
        disconnectChannel(name: string): void;
        disconnectGroupConversation(name: string): void;
        endDispatchCall(channelName: string): void;
        getConstants?(): {};
        getHistory(
            name: string,
            contactType: string,
            maxMessages: number,
        ): Promise<object>;
        getHistoryImageData(
            historyId: string,
            contactName: string,
            contactType: string,
        ): Promise<object>;
        leaveGroupConversation(conversationName: string): void;
        muteContact(name: string, contactType: string): void;
        playHistoryMessage(
            historyId: string,
            contactName: string,
            contactType: string,
        ): void;
        renameGroupConversation(conversationName: string, newName: string): void;
        selectContact(name: string, contactType: string): void;
        sendAlert(
            name: string,
            contactType: string,
            text: string,
            level: string,
        ): void;
        sendImage(name: string, contactType: string, data: number[]): void;
        sendLocation(name: string, contactType: string): void;
        sendText(name: string, contactType: string, text: string): void;
        setAccountStatus(status: string): void;
        startEmergency(): void;
        startVoiceMessage(name: string, contactType: string): void;
        stopEmergency(): void;
        stopHistoryMessagePlayback(): void;
        stopIncomingEmergency(emergencyId: string): void;
        stopVoiceMessage(): void;
        submitProblemReport(): void;
        unmuteContact(name: string, contactType: string): void;
    }

    Hierarchy

    • TurboModule
      • Spec
    Index
    • Parameters

      • conversationName: string
      • usernames: string[]

      Returns void

    • Parameters

      • network: string
      • username: string
      • password: string

      Returns void

    • Parameters

      • usernames: string[]
      • displayName: string

      Returns void

    • Returns {}

    • Parameters

      • name: string
      • contactType: string
      • maxMessages: number

      Returns Promise<object>

    • Parameters

      • historyId: string
      • contactName: string
      • contactType: string

      Returns Promise<object>

    • Parameters

      • name: string
      • contactType: string

      Returns void

    • Parameters

      • historyId: string
      • contactName: string
      • contactType: string

      Returns void

    • Parameters

      • conversationName: string
      • newName: string

      Returns void

    • Parameters

      • name: string
      • contactType: string

      Returns void

    • Parameters

      • name: string
      • contactType: string
      • text: string
      • level: string

      Returns void

    • Parameters

      • name: string
      • contactType: string
      • data: number[]

      Returns void

    • Parameters

      • name: string
      • contactType: string

      Returns void

    • Parameters

      • name: string
      • contactType: string
      • text: string

      Returns void

    • Parameters

      • name: string
      • contactType: string

      Returns void

    • Parameters

      • name: string
      • contactType: string

      Returns void