agora-react-native-rtm/lib/typescript/src/api/RTMPresence.d.ts

React Native around the Agora RTM SDKs for Android and iOS agora

import { ChannelInfo, PresenceOptions, RtmChannelType, StateItem, UserState } from '../legacy/AgoraRtmBase';
import { BaseResponse } from './RTMClient';
export type WhoNowResponse = BaseResponse & {
    totalOccupancy: number;
    occupants: UserState[];
    nextPage: string;
};
export type GetOnlineUsersResponse = WhoNowResponse;
export type WhereNowResponse = BaseResponse & {
    channels: ChannelInfo[];
    totalChannel: number;
};
export type GetUserChannelsResponse = WhereNowResponse;
export type SetStateResponse = BaseResponse;
export type GetStateResponse = UserState & BaseResponse;
export type RemoveStateResponse = BaseResponse;
export interface RemoveStateOptions {
    states?: string[];
}
export declare abstract class RTMPresence {
    abstract whoNow(channelName: string, channelType: RtmChannelType, options?: PresenceOptions): Promise<WhoNowResponse>;
    abstract getOnlineUsers(channelName: string, channelType: RtmChannelType, options?: PresenceOptions): Promise<GetOnlineUsersResponse>;
    abstract whereNow(userId: string): Promise<WhereNowResponse>;
    abstract getUserChannels(userId: string): Promise<GetUserChannelsResponse>;
    abstract setState(channelName: string, channelType: RtmChannelType, state: StateItem): Promise<SetStateResponse>;
    abstract getState(userId: string, channelName: string, channelType: RtmChannelType): Promise<GetStateResponse>;
    abstract removeState(channelName: string, channelType: RtmChannelType, options?: RemoveStateOptions): Promise<RemoveStateResponse>;
}
//# sourceMappingURL=RTMPresence.d.ts.map