@pano.video/panortc-react-native-sdk/lib/typescript/common/RtcMessageService.native.d.ts

PanoRtc SDK For React Native

import type { ResultCode } from './Enums';
import type { Subscription, RtcMessageServiceEventHandler } from './RtcEvents';
/**
 * The {@link RtcMessageService} class.
 */
export default class RtcMessageService implements RtcMessageServiceInterface {
    /**
     * @ignore
     */
    private _listeners;
    /**
     * @ignore
     */
    private static _callMethod;
    destroy(): void;
    /**
     * Adds the [`RtcMessageServiceEventHandler`]{@link RtcMessageServiceEventHandler} handler.
     *
     * After setting the [`RtcMessageServiceEventHandler`]{@link RtcMessageServiceEventHandler} handler, you can listen for `RtcMessageService` events and receive the statistics of the corresponding RtcMessageService instance.
     * @param event The event type.
     * @param listener The [`RtcMessageServiceEventHandler`]{@link RtcMessageServiceEventHandler} handler.
     */
    addListener<EventType extends keyof RtcMessageServiceEventHandler>(event: EventType, listener: RtcMessageServiceEventHandler[EventType]): Subscription;
    /**
     * Removes the [`RtcMessageServiceEventHandler`]{@link RtcMessageServiceEventHandler} handler.
     *
     * For callback events that you only want to listen for once, call this method to remove the specific [`RtcMessageServiceEventHandler`]{@link RtcMessageServiceEventHandler} objects after you have received them.
     * @param event The event type.
     * @param listener The [`RtcMessageServiceEventHandler`]{@link RtcMessageServiceEventHandler} handler.
     */
    removeListener<EventType extends keyof RtcMessageServiceEventHandler>(event: EventType, listener: RtcMessageServiceEventHandler[EventType]): void;
    /**
     * Removes all the [`RtcMessageServiceEventHandler`]{@link RtcMessageServiceEventHandler} handlers.
     * @param event The event type.
     */
    removeAllListeners<EventType extends keyof RtcMessageServiceEventHandler>(event?: EventType): void;
    /**
     * @~english
     * @brief Set or update meeting property
     * @param name  The property name.
     * @param value The to be set. if value is null or length is 0, then the property will be removed from server.
     * @return
     *  - OK: Success
     *  - others: Failure
     * @~chinese
     * @brief 设置或更属性
     * @param name  属性名字。
     * @param value 属性值。如果 value 为空，或者 length 为0，则此属性会被删除
     * @return
     *  - OK: 调用成功
     *  - others: 调用失败
     */
    setProperty(name: string, value: string): Promise<ResultCode>;
    /**
     * @~english
     * @brief Send message to specified user.
     * @param userId  The user ID.
     * @param message The message data in string format
     * @return
     *   - ResultCode.OK: Success
     *   - others: Failure
     * @note You can send messages at a maximum frequency of 150 calls every three seconds.
     *       The maximum data length is 4 KB.
     * @~chinese
     * @brief 发送消息给指定用户。
     * @param userId  用户标识。
     * @param message string类型消息数据
     * @return
     *   - ResultCode.OK: 成功
     *   - 其他: 失败
     * @note 发送消息的调用频率上限为每 3 秒 150 次。
     *       请确保消息大小不超过 4 KB。
     */
    sendMessage(message: string, userId: string): Promise<ResultCode>;
    /**
     * @~english
     * @brief Broadcast message.
     * @param message The message data in string format
     * @param sendBack Send back flag
     * @return
     *   - ResultCode.OK: Success
     *   - others: Failure
     * @note You can send messages at a maximum frequency of 150 calls every three seconds.
     *       The maximum data length is 4 KB.
     * @~chinese
     * @brief 广播消息。
     * @param message string类型消息数据
     * @param sendBack 是否回发消息
     * @return
     *   - ResultCode.OK: 成功
     *   - 其他: 失败
     * @note 发送消息的调用频率上限为每 3 秒 150 次。
     *       请确保消息大小不超过 4 KB。
     */
    broadcastMessage(message: string, sendBack?: boolean): Promise<ResultCode>;
    /**
     * @~english
     * @brief Publish topic.
     * @param topic The topic.
     * @param data  The topic data.
     * @return
     *   - OK: Success
     *   - others: Failure
     * @note You can send messages at a maximum frequency of 150 calls every 3 seconds.
     *       The maximum data length is 4 KB.
     * @~chinese
     * @brief 发布一个主题。
     * @param topic 主题标识。
     * @param data  主题数据。
     * @return
     *   - OK: 成功
     *   - 其他: 失败
     * @note 发送消息的调用频率上限为每 3 秒 150 次。
     *       请确保二进制消息大小不超过 4 KB。
     */
    publish(topic: string, data: string): Promise<ResultCode>;
    /**
     * @~english
     * @brief Subscribe topic.
     * @param topic The topic.
     * @return
     *   - OK: Success
     *   - others: Failure
     * @~chinese
     * @brief 订阅一个主题。
     * @param topic 主题标识。
     * @return
     *   - OK: 成功
     *   - 其他: 失败
     */
    subscribe(topic: string): Promise<ResultCode>;
    /**
     * @~english
     * @brief Unsubscribe topic.
     * @param topic The topic.
     * @return
     *   - OK: Success
     *   - others: Failure
     * @~chinese
     * @brief 取消订阅一个主题。
     * @param topic  主题标识。
     * @return
     *   - OK: 成功
     *   - 其他: 失败
     */
    unsubscribe(topic: string): Promise<ResultCode>;
}
interface RtcMessageServiceInterface {
    setProperty(name: string, value: string): Promise<ResultCode>;
    sendMessage(message: string, userId: string): Promise<ResultCode>;
    broadcastMessage(message: string, sendBack: boolean): Promise<ResultCode>;
    publish(topic: string, data: string): Promise<ResultCode>;
    subscribe(topic: string): Promise<ResultCode>;
    unsubscribe(topic: string): Promise<ResultCode>;
}
export {};