Memperbarui stream-chat dari 9.x ke 10.x
Perbandingan API publik stream-chat 9.55.0 dan 10.0.0, dihitung otomatis dari tipe TypeScript-nya. Tanda tangan yang berubah adalah kemungkinan perubahan tidak kompatibel, bukan kepastian.
Ringkasan
| Jalur impor yang dihapus | 0 |
|---|---|
| Ekspor yang dihapus | 454 |
| Tanda tangan yang berubah | 243 |
| Anggota kelas atau antarmuka yang dihapus | 320 |
| Anggota kelas atau antarmuka yang berubah | 345 |
| Baru ditandai usang | 7 |
| Perubahan persyaratan (engines, dependensi peer) | 1 |
| Ekspor baru | 740 |
Ekspor yang dihapus
| import | export | kind | Sebelum |
|---|---|---|---|
stream-chat | UR | type | { [x: string]: unknown; } |
stream-chat | Deny | variable | "Deny" |
stream-chat | Flag | type | { created_at: string; created_by_automod: boolean; updated_at: string; details?: FlagDetails | undefined; target_message?: MessageResponse | undefined; target_user?: UserResponse | undefined; user?: UserResponse | undefined; } |
stream-chat | Mute | type | { created_at: string; target: UserResponse; updated_at: string; user: UserResponse; } |
stream-chat | Sort | type | { [P in keyof T]?: AscDesc | undefined; } |
stream-chat | Allow | variable | "Allow" |
stream-chat | Pager | type | { limit?: number | undefined; next?: string | undefined; prev?: string | undefined; } |
stream-chat | Patch | type | (value: T) => T |
stream-chat | Device | type | BaseDeviceFields & { created_at: string; disabled?: boolean | undefined; disabled_reason?: string | undefined; } & { provider?: string | undefined; user?: UserResponse | undefined; user_id?: string | undefined; } |
stream-chat | Logger | type | (logLevel: LogLevel, message: string, extraData?: Record<string, unknown> | undefined) => void |
stream-chat | Policy | type | { action?: 0 | 1 | undefined; created_at?: string | undefined; name?: string | undefined; owner?: boolean | undefined; priority?: number | undefined; resources?: string[] | undefined; roles?: string[] | null | undefined; updated_at?: string | undefined; } |
stream-chat | AnyRole | variable | string[] |
stream-chat | AscDesc | type | 1 | -1 |
stream-chat | DenyAll | variable | Permission |
stream-chat | Handler | type | (nextValue: T, previousValue: T | undefined) => void |
stream-chat | Message | type | { id?: string | undefined; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; restricted_visibility?: string[] | undefined; show_in_channel?: boolean | undefined; silent?: boolean | undefined; text?: string | undefined; type?: MessageLabel | undefined; user?: UserResponse | null | undefined; user_id?: string | undefined; mentioned_users?: strin… |
stream-chat | Product | enum | Product |
stream-chat | Segment | class | class |
stream-chat | isPatch | variable | <T>(value: ValueOrPatch<T>): value is Patch<T> |
stream-chat | AllowAll | variable | Permission |
stream-chat | Campaign | class | class |
stream-chat | HookType | type | "webhook" | "sqs" | "sns" | "pending_message" |
stream-chat | PollData | type | CustomPollData & { id: string; name: string; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; max_votes_allowed?: number | undefined; options?: PollOptionData[] | undefined; user_id?: string | undefined; voting_visibility?: VotingVisibility | undefined; } |
stream-chat | PollSort | type | PollSortBase | PollSortBase[] |
stream-chat | PollVote | type | { created_at: string; id: string; poll_id: string; updated_at: string; option_id?: string | undefined; user?: UserResponse | undefined; user_id?: string | undefined; } |
stream-chat | Readable | type | { [key in keyof T]: T[key]; } |
stream-chat | Resource | type | "DeleteMessage" | "DeleteReaction" | "UpdateChannel" | "UpdateMessage" | "MuteUser" | "RunMessageAction" | "DeleteChannel" | "AddLinks" | "BanUser" | "CreateChannel" | "CreateMessage" | "CreateReaction" | "DeleteAttachment" | "EditUser" | "ReadChannel" | "UpdateChannelMembers" | "UpdateUser" | "UploadAttachment" |
stream-chat | Unpacked | type | T extends (infer U)[] ? U : T extends (...args: any[]) => infer U ? U : T extends Promise<infer U> ? U : T |
stream-chat | UserSort | type | Sort<UserResponse> | Sort<UserResponse>[] |
stream-chat | VoteSort | type | VoteSortBase | VoteSortBase[] |
stream-chat | parseSns | function | (notificationBody: string): Event |
stream-chat | parseSqs | function | (messageBody: string): Event |
stream-chat | APNConfig | type | { auth_key?: string | undefined; auth_type?: string | undefined; bundle_id?: string | undefined; development?: boolean | undefined; enabled?: boolean | undefined; host?: string | undefined; key_id?: string | undefined; notification_template?: string | undefined; p12_cert?: string | undefined; team_id?: string | undefined; } |
stream-chat | BlockList | type | { name: string; words: string[]; team?: string | undefined; type?: string | undefined; validate?: boolean | undefined; is_confusable_folding_enabled?: boolean | undefined; is_leet_check_enabled?: boolean | undefined; is_plural_check_enabled?: boolean | undefined; is_substring_matching_enabled?: boolean | undefined; } |
stream-chat | DraftSort | type | DraftSortBase | DraftSortBase[] |
stream-chat | EVENT_MAP | variable | { 'channel.created': boolean; 'channel.deleted': boolean; 'channel.hidden': boolean; 'channel.kicked': boolean; 'channel.muted': boolean; 'channel.truncated': boolean; 'channel.unmuted': boolean; 'channel.updated': boolean; 'channel.visible': boolean; 'draft.deleted': boolean; 'draft.updated': boolean; 'health.check': boolean; 'member.added': boolean; 'member.removed': boolean; 'member.updated': boolean; 'message.deleted': boolean; 'message.new': boolean; 'message.read': boolean; 'message.updated': boolean; 'message.undeleted': boolean; 'notification.added_to_channel': boolean; 'notification.c… |
stream-chat | EventHook | type | { id?: string | undefined; hook_type?: HookType | undefined; enabled?: boolean | undefined; product?: Product | "all" | undefined; event_types?: string[] | undefined; webhook_url?: string | undefined; sqs_queue_url?: string | undefined; sqs_region?: string | undefined; sqs_auth_type?: string | undefined; sqs_key?: string | undefined; sqs_secret?: string | undefined; sqs_role_arn?: string | undefined; sns_topic_arn?: string | undefined; sns_region?: string | undefined; sns_auth_type?: string | undefined; sns_key?: string | undefined; sns_secret?: string | undefined; sns_role_arn?: string | unde… |
stream-chat | GiphyData | type | { original: GiphyVersionInfo; fixed_height: GiphyVersionInfo; fixed_height_still: GiphyVersionInfo; fixed_height_downsampled: GiphyVersionInfo; fixed_width: GiphyVersionInfo; fixed_width_still: GiphyVersionInfo; fixed_width_downsampled: GiphyVersionInfo; } |
stream-chat | HookEvent | type | { name: string; description: string; products: Product[]; } |
stream-chat | KnownKeys | type | { [K in keyof T]: string extends K ? never : number extends K ? never : K; } extends { [_ in keyof T]: infer U; } ? U : never |
stream-chat | QuerySort | type | UserSort | BannedUsersSort | ChannelSort | SearchMessageSort |
stream-chat | SortParam | type | { field: string; direction?: AscDesc | undefined; } |
stream-chat | TeamsRole | type | { [team: string]: string; } |
stream-chat | AITextRule | type | { label: string; action?: ModerationActionType | undefined; severity_rules?: AITextSeverityRule[] | undefined; } |
stream-chat | DailyValue | type | { date: string; value: number; } |
stream-chat | DeleteType | type | "soft" | "hard" | "pruning" |
stream-chat | EventTypes | type | "all" | "channel.created" | "channel.deleted" | "channel.hidden" | "channel.kicked" | "channel.muted" | "channel.truncated" | "channel.unmuted" | "channel.updated" | "channel.visible" | "draft.deleted" | "draft.updated" | "health.check" | "member.added" | "member.removed" | "member.updated" | "message.deleted" | "message.new" | "message.read" | "message.updated" | "message.undeleted" | "notification.added_to_channel" | "notification.channel_deleted" | "message.delivered" | "notification.channel_mutes_updated" | "notification.channel_truncated" | "notification.invite_accepted" | "notification.i… |
stream-chat | FlagReport | type | { flags_count: number; id: string; message: MessageResponse; user: UserResponse; created_at?: string | undefined; details?: FlagDetails | undefined; first_reporter?: UserResponse | undefined; review_result?: string | undefined; reviewed_at?: string | undefined; reviewed_by?: UserResponse | undefined; updated_at?: string | undefined; } |
stream-chat | ImportTask | type | { created_at: string; history: ImportTaskHistory[]; id: string; path: string; state: string; updated_at: string; result?: UR | undefined; size?: number | undefined; } |
stream-chat | MemberSort | type | Sort<Pick<UserResponse, "created_at" | "updated_at" | "name" | "last_active"> & { user_id?: string | undefined; }> | Sort<Pick<UserResponse, "created_at" | "updated_at" | "name" | "last_active"> & { user_id?: string | undefined; }>[] |
stream-chat | MessageSet | type | { isCurrent: boolean; isLatest: boolean; messages: LocalMessage[]; pagination: { hasNext: boolean; hasPrev: boolean; }; } |
stream-chat | Permission | class | class |
stream-chat | PollAnswer | type | PollVote & { answer_text: string; is_answer: boolean; answer_text_i18n?: TranslatedField | undefined; } |
stream-chat | PollOption | type | { created_at: string; id: string; poll_id: string; text: string; updated_at: string; vote_count: number; text_i18n?: TranslatedField | undefined; votes?: PollVote[] | undefined; } |
stream-chat | StateStore | class | class |
stream-chat | TaskStatus | type | { created_at: string; status: string; task_id: string; updated_at: string; error?: { description: string; type: string; } | undefined; result?: UR | undefined; } |
stream-chat | ThreadSort | type | ThreadSortBase | ThreadSortBase[] |
stream-chat | parseEvent | function | (payload: any): Event |
stream-chat | AIImageRule | type | { action: ModerationActionType; label: string; min_confidence?: number | undefined; } |
stream-chat | AIVideoRule | type | { action: ModerationActionType; label: string; min_confidence?: number | undefined; } |
stream-chat | AnyResource | variable | string[] |
stream-chat | AppSettings | type | { allowed_flag_reasons?: string[] | undefined; apn_config?: { auth_key?: string | undefined; auth_type?: string | undefined; bundle_id?: string | undefined; development?: boolean | undefined; host?: string | undefined; key_id?: string | undefined; notification_template?: string | undefined; p12_cert?: string | undefined; team_id?: string | undefined; } | undefined; async_moderation_config?: AsyncModerationOptions | undefined; async_url_enrich_enabled?: boolean | undefined; auto_translation_enabled?: boolean | undefined; before_message_send_hook_url?: string | undefined; before_message_send_hoo… |
stream-chat | ChannelData | type | CustomChannelData & Partial<{ blocked: boolean; created_by: UserResponse | null; created_by_id: string; members: string[] | NewMemberPayload[]; blocklist_behavior: AutomodBehavior; automod: Automod; filter_tags: string[]; team?: string | undefined; }> |
stream-chat | ChannelRole | type | { custom?: boolean | undefined; name?: string | undefined; owner?: boolean | undefined; resource?: string | undefined; same_team?: boolean | undefined; } |
stream-chat | ChannelSort | type | ChannelSortBase | ChannelSortBase[] |
stream-chat | FlagDetails | type | { automod?: AutomodDetails | undefined; } |
stream-chat | MaxPriority | variable | 999 |
stream-chat | MessageBase | type | CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; restricted_visibility?: string[] | undefined; show_in_channel?: boolean | undefined; silent?: boolean | undefined; text?: string | undefined; type?: MessageLabel | undefined; user?: UserResponse | null | undefined; user_id?: string | undefined; } |
stream-chat | MetricStats | type | { daily?: DailyValue[] | undefined; total: number; } |
stream-chat | MinPriority | variable | 1 |
stream-chat | QueryFilter | type | NonNullable<ObjectType> extends string | number | boolean ? { $eq?: PrimitiveFilter<ObjectType> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<ObjectType> | undefined; $gte?: PrimitiveFilter<ObjectType> | undefined; $in?: PrimitiveFilter<ObjectType>[] | undefined; $lt?: PrimitiveFilter<ObjectType> | undefined; $lte?: PrimitiveFilter<ObjectType> | undefined; } : { $eq?: PrimitiveFilter<ObjectType> | undefined; $exists?: boolean | undefined; $in?: PrimitiveFilter<Unpacked<ObjectType>>[] | undefined; } |
stream-chat | SegmentData | type | { all_sender_channels?: boolean | undefined; all_users?: boolean | undefined; description?: string | undefined; filter?: {} | undefined; name?: string | undefined; } |
stream-chat | SegmentType | type | "user" | "channel" |
stream-chat | SyncOptions | type | { watch?: boolean | undefined; with_inaccessible_cids?: boolean | undefined; } |
stream-chat | UnknownType | type | { [x: string]: unknown; } |
stream-chat | Unsubscribe | type | () => void |
stream-chat | AnonUserType | type | {} |
stream-chat | BuiltinRoles | variable | { Admin: string; Anonymous: string; ChannelMember: string; ChannelModerator: string; Guest: string; User: string; } |
stream-chat | CampaignData | type | { channel_template?: { type: string; custom?: {} | undefined; id?: string | undefined; members?: string[] | undefined; members_template?: { user_id: string; channel_role?: string | undefined; custom?: Record<string, unknown> | undefined; }[] | undefined; team?: string | undefined; } | undefined; create_channels?: boolean | undefined; deleted_at?: string | undefined; description?: string | undefined; id?: string | null | undefined; message_template?: { text: string; attachments?: Attachment[] | undefined; custom?: {} | undefined; poll_id?: string | undefined; } | undefined; name?: string | unde… |
stream-chat | CampaignSort | type | { field: string; direction?: number | undefined; }[] |
stream-chat | DeviceFields | type | BaseDeviceFields & { created_at: string; disabled?: boolean | undefined; disabled_reason?: string | undefined; } |
stream-chat | DraftFilters | type | { channel_cid?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string> | undefined; created_at?: PrimitiveFilter<string> | RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFi… |
stream-chat | EndpointName | type | "Connect" | "LongPoll" | "DeleteFile" | "DeleteImage" | "DeleteMessage" | "DeleteUser" | "DeleteUsers" | "DeactivateUser" | "ExportUser" | "DeleteReaction" | "UpdateChannel" | "UpdateChannelPartial" | "UpdateMessage" | "UpdateMessagePartial" | "GetMessage" | "GetManyMessages" | "UpdateUsers" | "UpdateUsersPartial" | "CreateGuest" | "GetOrCreateChannel" | "StopWatchingChannel" | "QueryChannels" | "Search" | "QueryUsers" | "QueryMembers" | "QueryBannedUsers" | "QueryFlags" | "QueryMessageFlags" | "GetReactions" | "GetReplies" | "GetPinnedMessages" | "Ban" | "Unban" | "MuteUser" | "MuteChannel" |… |
stream-chat | FlagsFilters | type | { user_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?: PrimitiveFilter<string | undefined>[] | undefined; $lt?: PrimitiveFilter<string | undefined>; $lte?: PrimitiveFilter<string | undefined>; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string | undefined>; message_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | unde… |
stream-chat | HuaweiConfig | type | { enabled?: boolean | undefined; id?: string | undefined; secret?: string | undefined; } |
stream-chat | InsightTypes | type | "ws_fatal" | "ws_success_after_failure" | "http_hi_failed" |
stream-chat | InviteStatus | type | "member" | "pending" | "accepted" | "rejected" |
stream-chat | JWTUserToken | function | (apiSecret: jwt.Secret, userId: string, extraData?: UR | undefined, jwtOptions?: any): string |
stream-chat | PollSortBase | type | { created_at?: AscDesc | undefined; id?: AscDesc | undefined; is_closed?: AscDesc | undefined; name?: AscDesc | undefined; updated_at?: AscDesc | undefined; } |
stream-chat | PollVoteData | type | { answer_text?: string | undefined; is_answer?: boolean | undefined; option_id?: string | undefined; } |
stream-chat | Preprocessor | type | (nextValue: T, previousValue: T | undefined) => void |
stream-chat | ReactionSort | type | ReactionSortBase | ReactionSortBase[] |
stream-chat | ReadResponse | type | { last_read: string; user: UserResponse; last_read_message_id?: string | undefined; unread_messages?: number | undefined; last_delivered_at?: string | undefined; last_delivered_message_id?: string | undefined; } |
stream-chat | ReminderSort | type | Sort<Pick<ReminderResponseBase, "created_at" | "updated_at" | "channel_cid" | "remind_at">> | Sort<Pick<ReminderResponseBase, "created_at" | "updated_at" | "channel_cid" | "remind_at">>[] |
stream-chat | RoleResponse | type | { name: Role; custom: boolean; scopes: string[]; created_at: string; updated_at: string; } |
stream-chat | TaskResponse | type | { task_id: string; } |
stream-chat | ValueOrPatch | type | T | Patch<T> |
stream-chat | VoteSortBase | type | { created_at?: AscDesc | undefined; id?: AscDesc | undefined; is_closed?: AscDesc | undefined; name?: AscDesc | undefined; updated_at?: AscDesc | undefined; } |
stream-chat | XiaomiConfig | type | { enabled?: boolean | undefined; package_name?: string | undefined; secret?: string | undefined; } |
stream-chat | decodeBase64 | variable | (s: string): string |
stream-chat | encodeBase64 | variable | (data: string): string |
stream-chat | postInsights | variable | (insightType: InsightTypes, insights: Record<string, unknown>): Promise<void> |
stream-chat | AIVideoConfig | type | { enabled: boolean; rules: AIVideoRule[]; async?: boolean | undefined; } |
stream-chat | CampaignStats | type | { progress?: number | undefined; stats_channels_created?: number | undefined; stats_completed_at?: string | undefined; stats_messages_sent?: number | undefined; stats_started_at?: string | undefined; stats_users_read?: number | undefined; stats_users_sent?: number | undefined; } |
stream-chat | CheckResponse | type | APIResponse & { status: string; task_id?: string | undefined; recommended_action: string; item?: ReviewQueueItem | undefined; } |
stream-chat | DraftSortBase | type | { created_at?: AscDesc | undefined; } |
stream-chat | FlagsResponse | type | APIResponse & { flags?: Flag[] | undefined; } |
stream-chat | PolicyRequest | type | { action: (string & {}) | "Allow" | "Deny"; name: string; owner: boolean; priority: number; resources: string[]; roles: string[]; } |
stream-chat | RateLimitsMap | type | { Connect: RateLimitsInfo; LongPoll: RateLimitsInfo; DeleteFile: RateLimitsInfo; DeleteImage: RateLimitsInfo; DeleteMessage: RateLimitsInfo; DeleteUser: RateLimitsInfo; DeleteUsers: RateLimitsInfo; DeactivateUser: RateLimitsInfo; ExportUser: RateLimitsInfo; DeleteReaction: RateLimitsInfo; UpdateChannel: RateLimitsInfo; UpdateChannelPartial: RateLimitsInfo; UpdateMessage: RateLimitsInfo; UpdateMessagePartial: RateLimitsInfo; GetMessage: RateLimitsInfo; GetManyMessages: RateLimitsInfo; UpdateUsers: RateLimitsInfo; UpdateUsersPartial: RateLimitsInfo; CreateGuest: RateLimitsInfo; GetOrCreateChanne… |
stream-chat | SearchOptions | type | { limit?: number | undefined; next?: string | undefined; offset?: number | undefined; sort?: SearchMessageSort | undefined; } |
stream-chat | gunzipPayload | function | (rawBody: any): Buffer |
stream-chat | ArrayOneOrMore | type | { 0: T; } & T[] |
stream-chat | ArrayTwoOrMore | type | { 0: T; 1: T; } & T[] |
stream-chat | AutomodDetails | type | { action?: string | undefined; image_labels?: string[] | undefined; original_message_type?: string | undefined; result?: ModerationResult | undefined; } |
stream-chat | CheckPushInput | type | { apn_template?: string | undefined; client_id?: string | undefined; connection_id?: string | undefined; firebase_data_template?: string | undefined; firebase_template?: string | undefined; message_id?: string | undefined; user?: UserResponse | undefined; user_id?: string | undefined; } |
stream-chat | CheckSignature | function | (body: any, secret: string, signature: string): boolean |
stream-chat | CreatePollData | type | Partial<PollData> & Pick<PollData, "name"> |
stream-chat | FirebaseConfig | type | { apn_template?: string | undefined; credentials_json?: string | undefined; data_template?: string | undefined; enabled?: boolean | undefined; notification_template?: string | undefined; server_key?: string | undefined; } |
stream-chat | InsightMetrics | class | class |
stream-chat | JWTServerToken | function | (apiSecret: jwt.Secret, jwtOptions?: any): string |
stream-chat | MessageSetType | type | "latest" | "current" | "new" |
stream-chat | ModerationFlag | type | { created_at: string; custom: Record<string, any>; entity_creator_id: string; entity_id: string; entity_type: string; id: string; reason: string; result: Record<string, any>[]; review_queue_item_id: string; updated_at: string; user: UserResponse; moderation_payload?: ModerationPayload | undefined; moderation_payload_hash?: string | undefined; } |
stream-chat | ModerationRule | type | { id: string; name: string; description: string; config_keys: string[]; team: string; rule: RuleBuilderRule; enabled: boolean; created_at: string; updated_at: string; } |
stream-chat | PartializeKeys | type | Partial<Pick<T, K>> & Omit<T, K> |
stream-chat | PollEnrichData | type | { answers_count: number; latest_answers: PollAnswer[]; latest_votes_by_option: Record<string, PollVote[]>; vote_count: number; vote_counts_by_option: Record<string, number>; own_votes?: (PollVote | PollAnswer)[] | undefined; } |
stream-chat | PollOptionData | type | CustomPollOptionData & { text: string; id?: string | undefined; position?: number | undefined; } |
stream-chat | PushPreference | type | { call_level?: CallLevelPushPreference | undefined; channel_cid?: string | undefined; chat_level?: ChatLevelPushPreference | undefined; chat_preferences?: ChatPreferences | undefined; disabled_until?: string | undefined; remove_disable?: boolean | undefined; user_id?: string | undefined; } |
stream-chat | PushProviderID | type | { name: string; type: PushProvider; } |
stream-chat | RateLimitsInfo | type | { limit: number; remaining: number; reset: number; } |
stream-chat | RequestOptions | type | { signal?: AbortSignal | undefined; } |
stream-chat | TeamUsageStats | type | { team: string; users_daily: MetricStats; messages_daily: MetricStats; translations_daily: MetricStats; image_moderations_daily: MetricStats; concurrent_users: MetricStats; concurrent_connections: MetricStats; users_total: MetricStats; users_last_24_hours: MetricStats; users_last_30_days: MetricStats; users_month_to_date: MetricStats; users_engaged_last_30_days: MetricStats; users_engaged_month_to_date: MetricStats; messages_total: MetricStats; messages_last_24_hours: MetricStats; messages_last_30_days: MetricStats; messages_month_to_date: MetricStats; } |
stream-chat | ThreadSortBase | type | { active_participant_count?: AscDesc | undefined; created_at?: AscDesc | undefined; last_message_at?: AscDesc | undefined; parent_message_id?: AscDesc | undefined; participant_count?: AscDesc | undefined; reply_count?: AscDesc | undefined; updated_at?: AscDesc | undefined; } |
stream-chat | UpdatedMessage | type | Omit<MessageResponse, "created_at" | "deleted_at" | "pinned_at" | "updated_at" | "html" | "type" | "user" | "command" | "i18n" | "latest_reactions" | "mentioned_users" | "mentioned_groups" | "own_reactions" | "reaction_counts" | "reply_count" | "quoted_message" | "__html"> & { mentioned_users?: string[] | undefined; mentioned_channel?: boolean | undefined; mentioned_here?: boolean | undefined; mentioned_group_ids?: string[] | undefined; mentioned_roles?: string[] | undefined; type?: MessageLabel | undefined; } |
stream-chat | promoteChannel | variable | ({ channels, channelToMove, channelToMoveIndexWithinChannels, sort, }: PromoteChannelParams): Channel[] |
stream-chat | BannedUsersSort | type | BannedUsersSortBase | BannedUsersSortBase[] |
stream-chat | CampaignFilters | type | {} |
stream-chat | ChannelSortBase | type | Sort<CustomChannelData> & { created_at?: AscDesc | undefined; has_unread?: AscDesc | undefined; last_message_at?: AscDesc | undefined; last_updated?: AscDesc | undefined; member_count?: AscDesc | undefined; pinned_at?: AscDesc | undefined; unread_count?: AscDesc | undefined; updated_at?: AscDesc | undefined; } |
stream-chat | CommandResponse | type | Partial<CreatedAtUpdatedAt> & { args?: string | undefined; description?: string | undefined; name?: CommandVariants | undefined; set?: CommandVariants | undefined; } |
stream-chat | CommandVariants | type | "all" | "giphy" | "ban" | "fun_set" | "moderation_set" | "mute" | "unban" | "unmute" |
stream-chat | CustomCheckFlag | type | { type: string; custom?: Record<string, any>[] | undefined; labels?: string[] | undefined; reason?: string | undefined; } |
stream-chat | LLMSeverityRule | type | { severity: ModerationSeverity; action: ModerationActionType; } |
stream-chat | MarkReadOptions | type | { client_id?: string | undefined; connection_id?: string | undefined; thread_id?: string | undefined; user?: UserResponse | undefined; user_id?: string | undefined; } |
stream-chat | MuteUserOptions | type | { client_id?: string | undefined; connection_id?: string | undefined; id?: string | undefined; reason?: string | undefined; target_user_id?: string | undefined; timeout?: number | undefined; type?: string | undefined; user?: UserResponse | undefined; user_id?: string | undefined; } |
stream-chat | PrimitiveFilter | type | ObjectType | null |
stream-chat | PrivacySettings | type | { read_receipts?: { enabled?: boolean | undefined; } | undefined; typing_indicators?: { enabled?: boolean | undefined; } | undefined; delivery_receipts?: { enabled?: boolean | undefined; } | undefined; } |
stream-chat | PushProviderAPN | type | { apn_auth_key?: string | undefined; apn_auth_type?: "token" | "certificate" | undefined; apn_development?: boolean | undefined; apn_host?: string | undefined; apn_key_id?: string | undefined; apn_notification_template?: string | undefined; apn_p12_cert?: string | undefined; apn_team_id?: string | undefined; apn_topic?: string | undefined; } |
stream-chat | RetentionPolicy | type | { app_pk: number; policy: string; config: RetentionPolicyConfig; enabled_at: string; } |
stream-chat | ReviewQueueItem | type | { actions_taken: any[]; appealed_by: string; assigned_to: string; completed_at: string; config_key: string; context: any[]; created_at: string; created_by: string; entity_id: string; entity_type: string; entity_creator_id?: string | undefined; flags: ModerationFlag[]; has_image: boolean; has_text: boolean; has_video: boolean; id: string; moderation_payload: ModerationPayload; moderation_payload_hash: string; message?: MessageResponse | undefined; options: any; recommended_action: string; results: any; reviewed_at: string; status: string; updated_at: string; latest_moderator_action?: string | u… |
stream-chat | ReviewQueueSort | type | Sort<Pick<ReviewQueueItem, "created_at" | "updated_at" | "id">> | Sort<Pick<ReviewQueueItem, "created_at" | "updated_at" | "id">>[] |
stream-chat | SegmentResponse | type | { created_at: string; deleted_at: string; id: string; locked: boolean; size: number; task_id: string; type: SegmentType; updated_at: string; } & SegmentData |
stream-chat | TranslatedField | type | Required<Pick<Record<`${string & {}}_text`, string>, `${string & {}}_text`>> & Partial<Omit<Record<`${string & {}}_text`, string>, `${string & {}}_text`>> & { language: TranslationLanguages; } |
stream-chat | TruncateOptions | type | { hard_delete?: boolean | undefined; member_ids?: string[] | undefined; message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; restricted_visibility?: string[] | undefined; show_in_channel?: boolean | undefined; silent?: boolean | undefined; text?: string | undefined; type?: MessageLabel | undefin… |
stream-chat | UserCustomEvent | type | CustomEventData & { type: string; } |
stream-chat | verifySignature | function | (body: any, signature: string, secret: string): boolean |
stream-chat | APIErrorResponse | type | { duration: string; message: string; more_info: string; StatusCode: number; code?: number | undefined; details?: ErrorResponseDetails | undefined; } |
stream-chat | BaseDeviceFields | type | { id: string; push_provider: PushProvider; push_provider_name?: string | undefined; } |
stream-chat | CampaignResponse | type | { created_at: string; id: string; segments: SegmentResponse[]; sender: UserResponse; stats: CampaignStats; status: "draft" | "scheduled" | "in_progress" | "completed" | "stopped"; updated_at: string; users: UserResponse[]; scheduled_for?: string | undefined; } & CampaignData |
stream-chat | CheckSNSResponse | type | APIResponse & { status: string; data?: {} | undefined; error?: string | undefined; } |
stream-chat | CheckSQSResponse | type | APIResponse & { status: string; data?: {} | undefined; error?: string | undefined; } |
stream-chat | ContainsOperator | type | { [Key in keyof CustomType]?: (CustomType[Key] extends (infer ContainType)[] ? RequireOnlyOne<{ $contains?: (ContainType extends object ? PrimitiveFilter<RequireAtLeastOne<ContainType>> : PrimitiveFilter<ContainType>) | undefined; } & { $eq?: PrimitiveFilter<PrimitiveFilter<ContainType>[]> | undefined; $exists?: boolean | undefined; $in?: PrimitiveFilter<PrimitiveFilter<ContainType>>[] | undefined; }, "$eq" | "$exists" | "$in" | "$contains"> | PrimitiveFilter<PrimitiveFilter<ContainType>[]> : RequireOnlyOne<QueryFilter<CustomType[Key]>, keyof QueryFilter<CustomType[Key]>> | PrimitiveFilter<Cus… |
stream-chat | EventAPIResponse | type | APIResponse & { event: Event; } |
stream-chat | EventHandlerType | type | (args_0: Event) => void | Promise<void> | (() => void) | ((args_0: Event) => Promise<void>) |
stream-chat | FlagUserResponse | type | APIResponse & { flag: { created_at: string; created_by_automod: boolean; target_user: UserResponse; updated_at: string; user: UserResponse; approved_at?: string | undefined; details?: object | undefined; rejected_at?: string | undefined; reviewed_at?: string | undefined; reviewed_by?: string | undefined; }; review_queue_item_id?: string | undefined; } |
stream-chat | FutureChannelBan | type | { user: UserResponse; expires?: string | undefined; reason?: string | undefined; shadow?: boolean | undefined; created_at: string; } |
stream-chat | LocalMessageBase | type | Omit<MessageResponseBase, "created_at" | "deleted_at" | "pinned_at" | "status" | "updated_at"> & { created_at: Date; deleted_at: Date | null; pinned_at: Date | null; status: string; updated_at: Date; } |
stream-chat | MergedStateStore | class | class |
stream-chat | ModerationConfig | type | { key: string; ai_image_config?: AIImageConfig | undefined; ai_text_config?: AITextConfig | undefined; ai_video_config?: AIVideoConfig | undefined; automod_platform_circumvention_config?: AutomodPlatformCircumventionConfig | undefined; automod_semantic_filters_config?: AutomodSemanticFiltersConfig | undefined; automod_toxicity_config?: AutomodToxicityConfig | undefined; block_list_config?: BlockListConfig | undefined; llm_config?: LLMConfig | undefined; team?: string | undefined; } |
stream-chat | ModerationResult | type | { action: string; created_at: string; message_id: string; updated_at: string; user_bad_karma: boolean; user_karma: number; blocked_word?: string | undefined; blocklist_name?: string | undefined; moderated_by?: string | undefined; } |
stream-chat | MuteUserResponse | type | APIResponse & { mute?: MuteResponse | undefined; mutes?: Mute[] | undefined; own_user?: OwnUserResponse | undefined; non_existing_users?: string[] | undefined; } |
stream-chat | NewMemberPayload | type | CustomMemberData & Pick<ChannelMemberResponse, "user_id" | "channel_role"> |
stream-chat | PermissionObject | type | { action?: "Allow" | "Deny" | undefined; name?: string | undefined; owner?: boolean | undefined; priority?: number | undefined; resources?: string[] | undefined; roles?: string[] | undefined; } |
stream-chat | PredefinedFilter | type | { name: string; operation: "QueryChannels"; filter: F; created_at: string; updated_at: string; description?: string | undefined; sort?: PredefinedFilterSortParam[] | undefined; query_id?: number | undefined; } |
stream-chat | QueryPollsParams | type | { filter?: QueryPollsFilters | undefined; options?: Pager | undefined; sort?: PollSort | undefined; } |
stream-chat | ReactionSortBase | type | Sort<CustomReactionData> & { created_at?: AscDesc | undefined; } |
stream-chat | ReminderResponse | type | ReminderResponseBase & { user: UserResponse; message: MessageResponse; channel?: ChannelResponse | undefined; } |
stream-chat | TestSNSDataInput | type | { sns_key?: string | undefined; sns_secret?: string | undefined; sns_topic_arn?: string | undefined; } |
stream-chat | TestSQSDataInput | type | { sqs_key?: string | undefined; sqs_secret?: string | undefined; sqs_url?: string | undefined; } |
stream-chat | UsersAPIResponse | type | APIResponse & { users: UserResponse[]; membership_deletion_task_id?: string | undefined; } |
stream-chat | decodeSnsPayload | function | (notificationBody: string): Buffer |
stream-chat | decodeSqsPayload | function | (body: string): Buffer |
stream-chat | ChannelSetterType | type | (arg: ChannelSetterParameterType) => void |
stream-chat | CheckPushResponse | type | APIResponse & { device_errors?: { [deviceID: string]: { error_message?: string | undefined; provider?: PushProvider | undefined; provider_name?: string | undefined; }; } | undefined; general_errors?: string[] | undefined; rendered_apn_template?: string | undefined; rendered_firebase_template?: string | undefined; rendered_message?: {} | undefined; skip_devices?: boolean | undefined; } |
stream-chat | CustomCommandData | interface | interface |
stream-chat | DeleteUserOptions | type | { conversations?: "soft" | "hard" | "keep" | undefined; messages?: DeleteType | undefined; new_channel_owner_id?: string | undefined; user?: DeleteType | undefined; } |
stream-chat | ErrorFromResponse | class | class |
stream-chat | GetImportResponse | type | { import_task: ImportTask; } |
stream-chat | GetMessageOptions | type | { show_deleted_message?: boolean | undefined; } |
stream-chat | ImportTaskHistory | type | { created_at: string; next_state: string; prev_state: string; } |
stream-chat | MarkUnreadOptions | type | { client_id?: string | undefined; connection_id?: string | undefined; message_id?: string | undefined; thread_id?: string | undefined; message_timestamp?: string | Date | undefined; user?: UserResponse | undefined; user_id?: string | undefined; } |
stream-chat | ModV2ReviewStatus | type | "complete" | "flagged" | "partial" |
stream-chat | PaginationOptions | type | { created_at_after?: string | Date | undefined; created_at_after_or_equal?: string | Date | undefined; created_at_before?: string | Date | undefined; created_at_before_or_equal?: string | Date | undefined; id_gt?: string | undefined; id_gte?: string | undefined; id_lt?: string | undefined; id_lte?: string | undefined; limit?: number | undefined; offset?: number | undefined; } |
stream-chat | PartialUserUpdate | type | { id: string; set?: Partial<UserResponse> | undefined; unset?: ("created_at" | "deleted_at" | "updated_at" | "id" | "name" | "teams" | "username" | "anon" | "banned" | "blocked_user_ids" | "channel_last_read_at" | "deactivated_at" | "image" | "invisible" | "language" | "last_active" | "notifications_muted" | "online" | "privacy_settings" | "push_notifications" | "revoke_tokens_issued_before" | "role" | "shadow_banned" | "teams_role" | "avg_response_time")[] | undefined; } |
stream-chat | RetentionRunStats | type | { channels_deleted?: number | undefined; messages_deleted?: number | undefined; } |
stream-chat | SearchAPIResponse | type | APIResponse & { results: { message: MessageResponse; }[]; next?: string | undefined; previous?: string | undefined; results_warning?: SearchWarning | null | undefined; } |
stream-chat | SearchMessageSort | type | SearchMessageSortBase | SearchMessageSortBase[] |
stream-chat | StreamChatOptions | type | any |
stream-chat | TestPushDataInput | type | { apnTemplate?: string | undefined; firebaseDataTemplate?: string | undefined; firebaseTemplate?: string | undefined; messageID?: string | undefined; pushProviderName?: string | undefined; pushProviderType?: PushProvider | undefined; skipDevices?: boolean | undefined; } |
stream-chat | TranslateResponse | type | { language: string; translated_text: string; } |
stream-chat | UpdateSegmentData | type | { name: string; } & SegmentData |
stream-chat | AITextSeverityRule | type | { action: ModerationActionType; severity: ModerationSeverity; } |
stream-chat | BannedUsersFilters | type | { channel_cid?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?: PrimitiveFilter<string | undefined>[] | undefined; $lt?: PrimitiveFilter<string | undefined>; $lte?: PrimitiveFilter<string | undefined>; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string | undefined>; reason?: PrimitiveFilter<string | undefined> | RequireOnlyOne<{ $autocomplete?: string | undefined; } & { $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?… |
stream-chat | BlockedUserDetails | type | APIResponse & { blocked_user: UserResponse; blocked_user_id: string; created_at: string; user: UserResponse; user_id: string; } |
stream-chat | BuiltinPermissions | variable | { AddLinks: string; BanUser: string; CreateChannel: string; CreateMessage: string; CreateReaction: string; DeleteAnyAttachment: string; DeleteAnyChannel: string; DeleteAnyMessage: string; DeleteAnyReaction: string; DeleteOwnAttachment: string; DeleteOwnChannel: string; DeleteOwnMessage: string; DeleteOwnReaction: string; ReadAnyChannel: string; ReadOwnChannel: string; RunMessageAction: string; UpdateAnyChannel: string; UpdateAnyMessage: string; UpdateMembersAnyChannel: string; UpdateMembersOwnChannel: string; UpdateOwnChannel: string; UpdateOwnMessage: string; UploadAttachment: string; UseFroz… |
stream-chat | ChannelAPIResponse | type | { channel: ChannelResponse; members: ChannelMemberResponse[]; messages: MessageResponse[]; pinned_messages: MessageResponse[]; draft?: DraftResponse | undefined; hidden?: boolean | undefined; membership?: ChannelMemberResponse | null | undefined; pending_messages?: PendingMessageResponse[] | undefined; push_preferences?: ChannelPushPreference | undefined; read?: ReadResponse[] | undefined; threads?: ThreadResponse[] | undefined; watcher_count?: number | undefined; watchers?: UserResponse[] | undefined; active_live_locations?: SharedLocationResponse[] | undefined; } |
stream-chat | CreatedAtUpdatedAt | type | { created_at: string; updated_at: string; } |
stream-chat | ExportUsersRequest | type | { user_ids: string[]; } |
stream-chat | FlagReportsFilters | type | { report_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?: PrimitiveFilter<string | undefined>[] | undefined; $lt?: PrimitiveFilter<string | undefined>; $lte?: PrimitiveFilter<string | undefined>; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string | undefined>; review_result?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string |… |
stream-chat | GetCampaignOptions | type | { users?: { limit?: number | undefined; next?: string | undefined; prev?: string | undefined; } | undefined; } |
stream-chat | GetCommandResponse | type | APIResponse & CreateCommandOptions & CreatedAtUpdatedAt |
stream-chat | GetPollAPIResponse | type | { poll: PollResponse; } |
stream-chat | ModerationSeverity | type | "low" | "medium" | "high" | "critical" |
stream-chat | PinnedMessagesSort | type | PinnedMessagesSortBase | PinnedMessagesSortBase[] |
stream-chat | PushProviderCommon | type | { created_at: string; updated_at: string; description?: string | undefined; disabled_at?: string | undefined; disabled_reason?: string | undefined; } |
stream-chat | PushProviderConfig | type | PushProviderCommon & PushProviderID & PushProviderAPN & PushProviderFirebase & PushProviderHuawei & PushProviderXiaomi |
stream-chat | PushProviderHuawei | type | { huawei_app_id?: string | undefined; huawei_app_secret?: string | undefined; } |
stream-chat | PushProviderXiaomi | type | { xiaomi_package_name?: string | undefined; xiaomi_secret?: string | undefined; } |
stream-chat | RemovePreprocessor | type | () => void |
stream-chat | ReviewQueueFilters | type | { assigned_to?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string> | undefined; completed_at?: PrimitiveFilter<string> | RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: Primitive… |
stream-chat | SearchRolesOptions | type | { query: string; include_global_roles?: boolean | undefined; limit?: number | undefined; name_gt?: string | undefined; role_type?: "user" | "channel" | undefined; } |
stream-chat | UnmuteUserResponse | type | APIResponse & { non_existing_users?: string[] | undefined; } |
stream-chat | BannedUsersResponse | type | APIResponse & { bans?: { user: UserResponse; banned_by?: UserResponse | undefined; channel?: ChannelResponse | undefined; expires?: string | undefined; ip_ban?: boolean | undefined; reason?: string | undefined; timeout?: number | undefined; }[] | undefined; } |
stream-chat | BannedUsersSortBase | type | { created_at?: AscDesc | undefined; } |
stream-chat | CastVoteAPIResponse | type | { vote: PollVote | PollAnswer; } |
stream-chat | ChannelBatchUpdater | class | class |
stream-chat | ChannelConfigFields | type | { reminders: boolean; automod?: Automod | undefined; automod_behavior?: AutomodBehavior | undefined; automod_thresholds?: ChannelConfigAutomodThresholds | undefined; blocklist_behavior?: AutomodBehavior | undefined; connect_events?: boolean | undefined; custom_events?: boolean | undefined; delivery_events?: boolean | undefined; mark_messages_pending?: boolean | undefined; max_message_length?: number | undefined; message_retention?: string | undefined; mutes?: boolean | undefined; name?: string | undefined; polls?: boolean | undefined; push_notifications?: boolean | undefined; quotes?: boolean … |
stream-chat | ChannelQueryOptions | type | { client_id?: string | undefined; connection_id?: string | undefined; created_by?: UserResponse | null | undefined; created_by_id?: string | undefined; data?: ChannelResponse | undefined; hide_for_creator?: boolean | undefined; members?: PaginationOptions | undefined; messages?: MessagePaginationOptions | undefined; presence?: boolean | undefined; state?: boolean | undefined; watch?: boolean | undefined; watchers?: PaginationOptions | undefined; } |
stream-chat | CreateImportOptions | type | { mode: "insert" | "upsert"; } |
stream-chat | CustomCheckResponse | type | APIResponse & { id: string; item: ReviewQueueItem; status: string; } |
stream-chat | DraftMessagePayload | type | Partial<Pick<Omit<DraftMessage, "mentioned_groups">, "id">> & Omit<Omit<DraftMessage, "mentioned_groups">, "id"> & { user_id?: string | undefined; } |
stream-chat | ExportUsersResponse | type | { task_id: string; } |
stream-chat | ExtendedQueryFilter | type | QueryFilter<T> & { $autocomplete?: (T extends string ? string : never) | undefined; $contains?: ElementType<T> | undefined; $in?: ElementType<T>[] | undefined; $q?: (T extends string ? string : never) | undefined; } |
stream-chat | FlagMessageResponse | type | APIResponse & { flag: { created_at: string; created_by_automod: boolean; target_message_id: string; updated_at: string; user: UserResponse; approved_at?: string | undefined; channel_cid?: string | undefined; custom?: Record<string, unknown> | undefined; details?: object | undefined; message_user_id?: string | undefined; reason?: string | undefined; rejected_at?: string | undefined; reviewed_at?: string | undefined; reviewed_by?: string | undefined; }; review_queue_item_id?: string | undefined; } |
stream-chat | FlagReportsResponse | type | APIResponse & { flag_reports: FlagReport[]; } |
stream-chat | FlagsFiltersOptions | type | { channel_cid?: string | undefined; message_id?: string | undefined; message_user_id?: string | undefined; reporter_id?: string | undefined; team?: string | undefined; user_id?: string | undefined; } |
stream-chat | GetUserGroupOptions | type | { team_id?: string | undefined; } |
stream-chat | InvalidWebhookError | class | class |
stream-chat | ListChannelResponse | type | APIResponse & { channel_types: Record<string, Omit<CreateChannelOptions, "client_id" | "connection_id" | "commands"> & { commands: CommandResponse[]; created_at: string; updated_at: string; grants?: Record<string, string[]> | undefined; }>; } |
stream-chat | ListImportsResponse | type | { import_tasks: ImportTask[]; } |
stream-chat | LiveLocationPayload | type | { created_by_device_id: string; end_at: string; latitude: number; longitude: number; message_id: string; } |
stream-chat | MessageFlagsFilters | type | { channel_cid?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?: PrimitiveFilter<string | undefined>[] | undefined; $lt?: PrimitiveFilter<string | undefined>; $lte?: PrimitiveFilter<string | undefined>; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string | undefined>; team?: string | (string & Omit<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | un… |
stream-chat | MessageHistoryEntry | type | { message_id: string; message_updated_at: string; attachments?: Attachment[] | undefined; message_updated_by_id?: string | undefined; text?: string | undefined; } |
stream-chat | MessageResponseBase | type | CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; restricted_visibility?: string[] | undefined; show_in_channel?: boolean | undefined; silent?: boolean | undefined; text?: string | undefined; type?: MessageLabel | undefined; user?: UserResponse | null | undefined; user_id?: string | undefined; } & { type: Mess… |
stream-chat | PartialThreadUpdate | type | { set?: Partial<Record<string, unknown>> | undefined; unset?: string[] | undefined; } |
stream-chat | PartialUpdateMember | type | { set?: ChannelMemberUpdates | undefined; unset?: ("pinned" | "channel_role" | "archived")[] | undefined; } |
stream-chat | PermissionAPIObject | type | { action?: string | undefined; condition?: object | undefined; custom?: boolean | undefined; description?: string | undefined; id?: string | undefined; level?: string | undefined; name?: string | undefined; owner?: boolean | undefined; owner_resource?: string | undefined; same_team?: boolean | undefined; tags?: string[] | undefined; } |
stream-chat | PushPreferenceLevel | type | (string & {}) | "all" | "none" |
stream-chat | QueryThreadsOptions | type | { filter?: ThreadFilters | undefined; limit?: number | undefined; member_limit?: number | undefined; next?: string | undefined; participant_limit?: number | undefined; reply_limit?: number | undefined; sort?: ThreadSort | undefined; watch?: boolean | undefined; } |
stream-chat | ReactionAPIResponse | type | APIResponse & { message: MessageResponse; reaction: ReactionResponse; } |
stream-chat | ReminderAPIResponse | type | APIResponse & { reminder: ReminderResponse; } |
stream-chat | ReviewQueueResponse | type | { items: ReviewQueueItem[]; action_config?: Record<string, ModerationActionConfig[]> | undefined; filter_config?: FilterConfigResponse | undefined; stats?: Record<string, unknown> | undefined; next?: string | undefined; prev?: string | undefined; } |
stream-chat | SegmentQueryOptions | type | { limit?: number | undefined; next?: string | undefined; prev?: string | undefined; sort?: CampaignSort | undefined; user_limit?: number | undefined; } |
stream-chat | SendFileAPIResponse | type | APIResponse & { file: string; thumb_url?: string | undefined; } |
stream-chat | SendReactionOptions | type | { enforce_unique?: boolean | undefined; skip_push?: boolean | undefined; } |
stream-chat | SubmitActionOptions | type | { appeal_id?: string | undefined; ban?: { target_user_id?: string | undefined; shadow?: boolean | undefined; reason?: string | undefined; channel_ban_only?: boolean | undefined; channel_cid?: string | undefined; ip_ban?: boolean | undefined; delete_messages?: MessageDeletionStrategy | undefined; delete_reactions?: boolean | undefined; timeout?: number | undefined; } | undefined; block?: { reason?: string | undefined; } | undefined; custom?: { id: string; options?: Record<string, any> | undefined; } | undefined; delete_activity?: { hard_delete?: boolean | undefined; reason?: string | undefined;… |
stream-chat | VotesFiltersOptions | type | { is_answer?: boolean | undefined; option_id?: string | undefined; user_id?: string | undefined; } |
stream-chat | buildWsFatalInsight | function | (connection: StableWSConnection, event: Record<string, unknown>): { ready_state: 0 | 2 | 1 | 3 | undefined; url: string; api_key: string; start_ts: number | null; end_ts: number; auth_type: string; token: string | undefined; user_id: string | undefined; user_details: UserResponse | OwnUserResponse | undefined; device: BaseDeviceFields | undefined; client_id: string | undefined; ws_details: any; ws_consecutive_failures: number; ws_total_failures: number; request_id: string | undefined; online: boolean | null; user_agent: string | null; instance_client_id: string; } |
stream-chat | BatchUpdateOperation | type | "addMembers" | "removeMembers" | "inviteMembers" | "assignRoles" | "addModerators" | "demoteModerators" | "hide" | "show" | "archive" | "unarchive" | "updateData" |
stream-chat | BlockUserAPIResponse | type | APIResponse & { blocked_at: string; blocked_by_user_id: string; blocked_user_id: string; } |
stream-chat | CampaignQueryOptions | type | { limit?: number | undefined; next?: string | undefined; prev?: string | undefined; sort?: CampaignSort | undefined; user_limit?: number | undefined; } |
stream-chat | ChannelConfigAutomod | type | (string & {}) | "disabled" | "simple" | "AI" |
stream-chat | ChannelMemberUpdates | type | CustomMemberData & { archived?: boolean | undefined; channel_role?: Role | undefined; pinned?: boolean | undefined; } |
stream-chat | CreateChannelOptions | type | { automod?: Automod | undefined; automod_behavior?: AutomodBehavior | undefined; automod_thresholds?: ChannelConfigAutomodThresholds | undefined; blocklist?: string | undefined; blocklist_behavior?: AutomodBehavior | undefined; client_id?: string | undefined; commands?: CommandVariants[] | undefined; connect_events?: boolean | undefined; connection_id?: string | undefined; custom_events?: boolean | undefined; delivery_events?: boolean | undefined; grants?: Record<string, string[]> | undefined; mark_messages_pending?: boolean | undefined; max_message_length?: number | undefined; message_retenti… |
stream-chat | CreateCommandOptions | type | { description: string; name: CommandVariants; args?: string | undefined; set?: CommandVariants | undefined; } |
stream-chat | CreateImportResponse | type | { import_task: ImportTask; } |
stream-chat | ExportChannelOptions | type | { clear_deleted_message_text?: boolean | undefined; export_users?: boolean | undefined; include_soft_deleted_channels?: boolean | undefined; include_truncated_messages?: boolean | undefined; version?: string | undefined; } |
stream-chat | ExportChannelRequest | type | ({ id: string; type: string; } | { cid: string; }) & { messages_since?: Date | undefined; messages_until?: Date | undefined; } |
stream-chat | ExtendedQueryFilters | type | { [K in keyof T]?: ExtendedQueryFilter<T[K]> | undefined; } & ExtendedQueryLogicalOperators<T> |
stream-chat | GetThreadAPIResponse | type | APIResponse & { thread: ThreadResponse; } |
stream-chat | ListCommandsResponse | type | APIResponse & { commands: (CreateCommandOptions & Partial<CreatedAtUpdatedAt>)[]; } |
stream-chat | ListRolesAPIResponse | type | APIResponse & { roles: RoleResponse[]; } |
stream-chat | MarkDeliveredOptions | type | { latest_delivered_messages: DeliveredMessageConfirmation[]; user?: UserResponse | undefined; user_id?: string | undefined; } |
stream-chat | MessageFlagsResponse | type | APIResponse & { flags?: { message: MessageResponse; user: UserResponse; approved_at?: string | undefined; created_at?: string | undefined; created_by_automod?: boolean | undefined; moderation_result?: ModerationResult | undefined; rejected_at?: string | undefined; reviewed_at?: string | undefined; reviewed_by?: UserResponse | undefined; updated_at?: string | undefined; }[] | undefined; } |
stream-chat | ModerationActionType | type | "flag" | "bounce" | "remove" | "shadow" | "bounce_flag" | "bounce_remove" |
stream-chat | PartialMessageUpdate | type | { set?: (Partial<MessageUpdatableFields> & { [path: `${string}.${string}`]: unknown; }) | undefined; unset?: ("pinned_at" | "status" | "id" | "attachments" | "html" | "mml" | "parent_id" | "pin_expires" | "pinned" | "poll_id" | "quoted_message_id" | "restricted_visibility" | "show_in_channel" | "silent" | "text" | "type" | "args" | "before_message_send_failed" | "channel" | "command" | "command_info" | "deleted_reply_count" | "i18n" | "latest_reactions" | "member" | "mentioned_users" | "mentioned_channel" | "mentioned_here" | "mentioned_group_ids" | "mentioned_groups" | "mentioned_roles" | "me… |
stream-chat | PartialUpdateChannel | type | { set?: (Partial<ChannelResponse> & { config_overrides?: Partial<ChannelConfigFields> | undefined; } & { [path: `${string}.${string}`]: unknown; }) | undefined; unset?: ("created_at" | "deleted_at" | "updated_at" | "id" | "type" | "cid" | "team" | "members" | "disabled" | "frozen" | "blocked" | "auto_translation_enabled" | "auto_translation_language" | "hide_messages_before" | "config" | "cooldown" | "created_by" | "created_by_id" | "filter_tags" | "hidden" | "invites" | "joined" | "last_message_at" | "member_count" | "message_count" | "muted" | "mute_expires_at" | "own_capabilities" | "trunca… |
stream-chat | PollVotesAPIResponse | type | { votes: (PollVote | PollAnswer)[]; next?: string | undefined; } |
stream-chat | PredefinedFilterSort | type | SortParam[] |
stream-chat | PromoteChannelParams | type | { channels: Channel[]; channelToMove: Channel; sort: ChannelSort; channelToMoveIndexWithinChannels?: number | undefined; } |
stream-chat | PushProviderFirebase | type | { firebase_apn_template?: string | undefined; firebase_credentials?: string | undefined; firebase_data_template?: string | undefined; firebase_notification_template?: string | undefined; firebase_server_key?: string | undefined; } |
stream-chat | QueryConfigsResponse | type | { configs: ModerationConfigResponse[]; next?: string | undefined; prev?: string | undefined; } |
stream-chat | QuerySegmentsOptions | type | { limit?: number | undefined; next?: string | undefined; prev?: string | undefined; } |
stream-chat | ReminderResponseBase | type | { channel_cid: string; created_at: string; message_id: string; updated_at: string; user_id: string; remind_at?: string | undefined; } |
stream-chat | RetentionRunResponse | type | { app_pk: number; policy: string; date: string; stats: RetentionRunStats; } |
stream-chat | TranslationLanguages | type | "id" | "af" | "am" | "ar" | "az" | "bg" | "bn" | "bs" | "cs" | "da" | "de" | "el" | "en" | "es" | "es-MX" | "et" | "fa" | "fa-AF" | "fi" | "fr" | "fr-CA" | "ha" | "he" | "hi" | "hr" | "hu" | "it" | "ja" | "ka" | "ko" | "lt" | "lv" | "ms" | "nl" | "no" | "pl" | "ps" | "pt" | "ro" | "ru" | "sk" | "sl" | "so" | "sq" | "sr" | "sv" | "sw" | "ta" | "th" | "tl" | "tr" | "uk" | "ur" | "vi" | "zh" | "zh-TW" | (string & {}) |
stream-chat | UpdateChannelOptions | type | { accept_invite?: boolean | undefined; add_members?: string[] | undefined; add_moderators?: string[] | undefined; client_id?: string | undefined; connection_id?: string | undefined; data?: Omit<ChannelResponse, "id" | "cid"> | undefined; demote_moderators?: string[] | undefined; invites?: string[] | undefined; message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; p… |
stream-chat | UpdateCommandOptions | type | { description: string; args?: string | undefined; set?: CommandVariants | undefined; } |
stream-chat | ChannelPushPreference | type | { chat_level?: ChatLevelPushPreference | undefined; chat_preferences?: ChatPreferences | undefined; disabled_until?: string | undefined; } |
stream-chat | ConnectionChangeEvent | type | { type: EventTypes; online?: boolean | undefined; } |
stream-chat | CreateChannelResponse | type | APIResponse & Omit<CreateChannelOptions, "client_id" | "connection_id"> & { created_at: string; updated_at: string; grants?: Record<string, string[]> | undefined; } |
stream-chat | CreateCommandResponse | type | APIResponse & { command: CreateCommandOptions & CreatedAtUpdatedAt; } |
stream-chat | CreatePollAPIResponse | type | { poll: PollResponse; } |
stream-chat | CreateReminderOptions | type | { messageId: string; remind_at?: string | null | undefined; user_id?: string | undefined; } |
stream-chat | CreateRoleAPIResponse | type | APIResponse & { role: RoleResponse; } |
stream-chat | DeleteCampaignOptions | type | {} |
stream-chat | DeleteCommandResponse | type | APIResponse & { name?: CommandVariants | undefined; } |
stream-chat | DeleteMessagesOptions | type | "soft" | "hard" | "pruning" |
stream-chat | ExportChannelResponse | type | { task_id: string; } |
stream-chat | FormatMessageResponse | type | Omit<MessageResponseBase, "created_at" | "deleted_at" | "pinned_at" | "status" | "updated_at"> & { created_at: Date; deleted_at: Date | null; pinned_at: Date | null; status: string; updated_at: Date; } & { error?: ErrorFromResponse<APIErrorResponse> | null | undefined; quoted_message?: LocalMessageBase | null | undefined; } |
stream-chat | GetHookEventsResponse | type | APIResponse & { events: HookEvent[]; } |
stream-chat | GetMessageAPIResponse | type | APIResponse & { message: MessageResponse; pending_message_metadata?: Record<string, string> | null | undefined; } |
stream-chat | GetRateLimitsResponse | type | APIResponse & { android?: RateLimitsMap | undefined; ios?: RateLimitsMap | undefined; server_side?: RateLimitsMap | undefined; web?: RateLimitsMap | undefined; } |
stream-chat | GetRepliesAPIResponse | type | APIResponse & { messages: MessageResponse[]; } |
stream-chat | LiteralStringForUnion | type | string & {} |
stream-chat | ModerationMuteOptions | type | { timeout?: number | undefined; user_id?: string | undefined; } |
stream-chat | ModerationRuleRequest | type | { name: string; description: string; config_keys: string[]; team: string; rule: RuleBuilderRule; enabled: boolean; } |
stream-chat | PermissionAPIResponse | type | APIResponse & { permission?: PermissionAPIObject | undefined; } |
stream-chat | PollPaginationOptions | type | { limit?: number | undefined; next?: string | undefined; } |
stream-chat | QueryReactionsOptions | type | { limit?: number | undefined; next?: string | undefined; prev?: string | undefined; } |
stream-chat | QueryRemindersOptions | type | Pager & { filter?: ReminderFilters | undefined; sort?: ReminderSort | undefined; } |
stream-chat | ReactivateUserOptions | type | { created_by_id?: string | undefined; name?: string | undefined; restore_messages?: boolean | undefined; } |
stream-chat | RetentionPolicyConfig | type | { max_age_hours: number; } |
stream-chat | SearchMessageSortBase | type | Sort<CustomMessageData> & { attachments?: AscDesc | undefined; 'attachments.type'?: AscDesc | undefined; created_at?: AscDesc | undefined; id?: AscDesc | undefined; 'mentioned_users.id'?: AscDesc | undefined; parent_id?: AscDesc | undefined; pinned?: AscDesc | undefined; relevance?: AscDesc | undefined; reply_count?: AscDesc | undefined; text?: AscDesc | undefined; type?: AscDesc | undefined; updated_at?: AscDesc | undefined; 'user.id'?: AscDesc | undefined; } |
stream-chat | StaticLocationPayload | type | { created_by_device_id: string; latitude: number; longitude: number; message_id: string; } |
stream-chat | UpdateCommandResponse | type | APIResponse & { command: UpdateCommandOptions & CreatedAtUpdatedAt & { name: CommandVariants; }; } |
stream-chat | UpdateLocationPayload | type | { message_id: string; created_by_device_id?: string | undefined; end_at?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; user?: { id: string; } | undefined; user_id?: string | undefined; } |
stream-chat | UpdatePollAPIResponse | type | { poll: PollResponse; } |
stream-chat | UpdateReminderOptions | type | { messageId: string; remind_at?: string | null | undefined; user_id?: string | undefined; } |
stream-chat | verifyAndParseWebhook | function | (rawBody: any, signature: string, secret: string): Event |
stream-chat | AppSettingsAPIResponse | type | APIResponse & { app?: { id?: string | number | undefined; activity_metrics_config?: Record<string, number> | undefined; allow_multi_user_devices?: boolean | undefined; feed_audit_logs_enabled?: boolean | undefined; moderation_onboarding_complete?: boolean | null | undefined; call_types: any; channel_configs: Record<string, { reminders: boolean; automod?: Automod | undefined; automod_behavior?: AutomodBehavior | undefined; automod_thresholds?: ChannelConfigAutomodThresholds | undefined; blocklist_behavior?: AutomodBehavior | undefined; commands?: CommandVariants[] | undefined; connect_events?: … |
stream-chat | AsyncModerationOptions | type | { callback?: { mode?: "CALLBACK_MODE_NONE" | "CALLBACK_MODE_REST" | "CALLBACK_MODE_TWIRP" | undefined; server_url?: string | undefined; } | undefined; timeout_ms?: number | undefined; } |
stream-chat | BatchChannelDataUpdate | type | { frozen?: boolean | undefined; disabled?: boolean | undefined; custom?: Record<string, unknown> | undefined; team?: string | undefined; config_overrides?: Record<string, unknown> | undefined; auto_translation_enabled?: boolean | undefined; auto_translation_language?: string | undefined; } |
stream-chat | CreateUserGroupOptions | type | { name: string; description?: string | undefined; id?: string | undefined; member_ids?: string[] | undefined; team_id?: string | undefined; } |
stream-chat | DeactivateUsersOptions | type | { created_by_id?: string | undefined; mark_messages_deleted?: boolean | undefined; } |
stream-chat | DeleteUserGroupOptions | type | { team_id?: string | undefined; } |
stream-chat | FlagsPaginationOptions | type | { limit?: number | undefined; offset?: number | undefined; } |
stream-chat | GetChannelTypeResponse | type | { automod: Automod; automod_behavior: AutomodBehavior; commands: Command[]; connect_events: boolean; created_at: string; custom_events: boolean; delivery_events: boolean; duration: string; grants: Record<string, string[]>; mark_messages_pending: boolean; max_message_length: number; mutes: boolean; name: string; permissions: PolicyRequest[]; polls: boolean; push_notifications: boolean; quotes: boolean; reactions: boolean; read_events: boolean; reminders: boolean; replies: boolean; search: boolean; shared_locations: boolean; skip_last_msg_update_for_system_msgs: boolean; typing_events: boolean; … |
stream-chat | MessageUpdatableFields | type | { pinned_at?: string | null | undefined; status?: string | undefined; id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; restricted_visibility?: string[] | undefined; show_in_channel?: boolean | undefined; silent?: boolean | undefined; text?: string | undefined; type: "deleted" | "ephemeral" | "error" | "regular" | "reply" | "system"; args?: string | undefined; before_me… |
stream-chat | ModerationActionConfig | type | { entity_type: string; order: number; action: string; icon: string; description: string; custom?: Record<string, unknown> | undefined; } |
stream-chat | ModerationHarmResponse | type | { name: string; phrase_list_ids: number[]; } |
stream-chat | MuteChannelAPIResponse | type | APIResponse & { channel_mute: ChannelMute; own_user: OwnUserResponse; channel_mutes?: ChannelMute[] | undefined; mute?: MuteResponse | undefined; } |
stream-chat | PermissionsAPIResponse | type | APIResponse & { permissions?: PermissionAPIObject[] | undefined; } |
stream-chat | PinnedMessagesSortBase | type | { pinned_at?: AscDesc | undefined; } |
stream-chat | PollAnswersAPIResponse | type | { votes: PollAnswer[]; next?: string | undefined; } |
stream-chat | QueryUserGroupsOptions | type | { limit?: number | undefined; id_gt?: string | undefined; created_at_gt?: string | undefined; team_id?: string | undefined; } |
stream-chat | ReactivateUsersOptions | type | { created_by_id?: string | undefined; restore_messages?: boolean | undefined; } |
stream-chat | SearchRolesAPIResponse | type | APIResponse & { roles: RoleResponse[]; } |
stream-chat | SegmentTargetsResponse | type | { created_at: string; segment_id: string; target_id: string; } |
stream-chat | UpdateUserGroupOptions | type | { description?: string | undefined; name?: string | undefined; team_id?: string | undefined; } |
stream-chat | UpdateUsersAPIResponse | type | APIResponse & { users: { [key: string]: UserResponse; }; membership_deletion_task_id?: string | undefined; } |
stream-chat | CallLevelPushPreference | type | (string & {}) | "all" | "none" | "default" |
stream-chat | ChatLevelPushPreference | type | (string & {}) | "all" | "mentions" | "all_mentions" | "direct_mentions" | "none" | "default" |
stream-chat | CreateImportURLResponse | type | { path: string; upload_url: string; } |
stream-chat | CustomPermissionOptions | type | { action: string; condition: object; id: string; name: string; description?: string | undefined; owner?: boolean | undefined; same_team?: boolean | undefined; } |
stream-chat | GenericEventHandlerType | type | (...args: T) => void | Promise<void> | (() => void) | ((...args: T) => Promise<void>) |
stream-chat | GetReactionsAPIResponse | type | APIResponse & { reactions: ReactionResponse[]; } |
stream-chat | MarkChannelsReadOptions | type | { client_id?: string | undefined; connection_id?: string | undefined; read_by_channel?: Record<string, string> | undefined; user?: UserResponse | undefined; user_id?: string | undefined; } |
stream-chat | MessageDeletionStrategy | type | "soft" | "hard" | "pruning" |
stream-chat | PartialPollOptionUpdate | type | { set?: Partial<PollOptionResponse> | undefined; unset?: ("created_at" | "updated_at" | "id" | "poll_id" | "text" | "vote_count" | "position" | "text_i18n" | "votes")[] | undefined; } |
stream-chat | QueryChannelAPIResponse | type | APIResponse & ChannelAPIResponse |
stream-chat | QueryMessageHistorySort | type | QueryMessageHistorySortBase | QueryMessageHistorySortBase[] |
stream-chat | QueryThreadsAPIResponse | type | APIResponse & { threads: ThreadResponse[]; next?: string | undefined; } |
stream-chat | QueryUserGroupsResponse | type | APIResponse & { user_groups: UserGroupResponse[]; } |
stream-chat | ReviewFlagReportOptions | type | { review_details?: object | undefined; user_id?: string | undefined; } |
stream-chat | ThreadManagerPagination | type | { isLoading: boolean; isLoadingNext: boolean; nextCursor: string | null; } |
stream-chat | ThreadRepliesPagination | type | { isLoadingNext: boolean; isLoadingPrev: boolean; nextCursor: string | null; prevCursor: string | null; } |
stream-chat | UserGroupMemberResponse | type | { group_id: string; user_id: string; is_admin: boolean; created_at: string; } |
stream-chat | BannedUsersFilterOptions | type | { banned_by_id?: string | undefined; channel_cid?: string | undefined; created_at?: string | undefined; reason?: string | undefined; user_id?: string | undefined; } |
stream-chat | ChannelManagerEventTypes | type | "channel.deleted" | "channel.hidden" | "channel.truncated" | "channel.updated" | "channel.visible" | "member.updated" | "message.new" | "notification.added_to_channel" | "notification.message_new" | "notification.removed_from_channel" |
stream-chat | ChannelManagerPagination | type | { filters: ChannelFilters; hasNext: boolean; isLoading: boolean; isLoadingNext: boolean; options: ChannelOptions; responseFilters?: ChannelFilters | undefined; responseSort?: ChannelSort | undefined; sort: ChannelSort; } |
stream-chat | ChannelMemberAPIResponse | type | APIResponse & { members: ChannelMemberResponse[]; } |
stream-chat | DeleteChannelAPIResponse | type | APIResponse & { channel: ChannelResponse; } |
stream-chat | EventHandlerOverrideType | type | (args_0: ChannelSetterType, args_1: Event) => void | Promise<void> | (() => void) | ((args_0: ChannelSetterType, args_1: Event) => Promise<void>) |
stream-chat | GetPollOptionAPIResponse | type | { poll_option: PollOptionResponse; } |
stream-chat | MessagePaginationOptions | type | PaginationOptions & { created_at_around?: string | Date | undefined; id_around?: string | undefined; } |
stream-chat | ModerationConfigResponse | type | ModerationConfig & { created_at: string; updated_at: string; } |
stream-chat | PredefinedFilterResponse | type | APIResponse & { predefined_filter: PredefinedFilter<F>; } |
stream-chat | PushNotificationSettings | type | { disabled?: boolean | undefined; disabled_until?: string | null | undefined; } |
stream-chat | PushProviderListResponse | type | { push_providers: PushProvider[]; } |
stream-chat | QueryChannelsAPIResponse | type | APIResponse & { channels: Omit<ChannelAPIResponse, keyof APIResponse>[]; predefined_filter?: ParsedPredefinedFilterResponse<Record<string, unknown>> | undefined; } |
stream-chat | QueryChannelsRequestType | type | (filters: ChannelFilters, sort?: ChannelSort | undefined, options?: ChannelOptions | undefined, stateOptions?: ChannelStateOptions | undefined) => Promise<QueryChannelsRequestOutput> |
stream-chat | QueryModerationRulesSort | type | Sort<"created_at" | "updated_at" | "name" | "team" | "enabled">[] |
stream-chat | ReviewFlagReportResponse | type | APIResponse & { flag_report: FlagReport; } |
stream-chat | UpdateChannelAPIResponse | type | APIResponse & { channel: ChannelResponse; members: ChannelMemberResponse[]; message?: MessageResponse | undefined; } |
stream-chat | UpdateChannelTypeRequest | type | Partial<{ automod: Automod; automod_behavior: AutomodBehavior; max_message_length: number; }> & { allowed_flag_reasons?: string[] | undefined; automod_thresholds?: Partial<Record<"explicit" | "spam" | "toxic", Partial<{ block: number; flag: number; }>>> | undefined; blocklist?: string | undefined; blocklist_behavior?: AutomodBehavior | undefined; blocklists?: BlockListOptions[] | undefined; commands?: CommandVariants[] | undefined; connect_events?: boolean | undefined; custom_events?: boolean | undefined; delivery_events?: boolean | undefined; grants?: Record<string, string[]> | undefined; mar… |
stream-chat | isSharedLocationResponse | variable | (location: unknown): location is SharedLocationResponse |
stream-chat | FlagReportsFiltersOptions | type | { channel_cid?: string | undefined; is_reviewed?: boolean | undefined; message_id?: string | undefined; message_user_id?: string | undefined; report_id?: string | undefined; review_result?: string | undefined; reviewed_by?: string | undefined; team?: string | undefined; user_id?: string | undefined; } |
stream-chat | FutureChannelBansResponse | type | APIResponse & { bans: FutureChannelBan[]; } |
stream-chat | GetUnreadCountAPIResponse | type | APIResponse & { channel_type: { channel_count: number; channel_type: string; unread_count: number; }[]; channels: { channel_id: string; last_read: string; unread_count: number; }[]; threads: { last_read: string; last_read_message_id: string; parent_message_id: string; unread_count: number; }[]; total_unread_count: number; total_unread_threads_count: number; total_unread_count_by_team?: Record<string, number> | undefined; } |
stream-chat | MessageComposerSetupState | type | { setupFunction: MessageComposerSetupFunction | null; } |
stream-chat | ModerationDetailsResponse | type | { action: (string & {}) | "MESSAGE_RESPONSE_ACTION_BOUNCE"; error_msg: string; harms: ModerationHarmResponse[]; original_text: string; } |
stream-chat | PredefinedFilterOperation | type | "QueryChannels" |
stream-chat | PredefinedFilterSortParam | type | { field: string; direction?: AscDesc | undefined; type?: string | undefined; } |
stream-chat | QueryReactionsAPIResponse | type | APIResponse & { reactions: ReactionResponse[]; next?: string | undefined; } |
stream-chat | QuerySegmentTargetsFilter | type | { target_id?: { $eq?: string | undefined; $gte?: string | undefined; $in?: string[] | undefined; $lte?: string | undefined; } | undefined; } |
stream-chat | UpdateChannelTypeResponse | type | { automod: Automod; automod_behavior: AutomodBehavior; commands: CommandVariants[]; connect_events: boolean; created_at: string; custom_events: boolean; delivery_events: boolean; duration: string; grants: Record<string, string[]>; mark_messages_pending: boolean; max_message_length: number; mutes: boolean; name: string; permissions: PolicyRequest[]; polls: boolean; push_notifications: boolean; quotes: boolean; reactions: boolean; read_events: boolean; reminders: boolean; replies: boolean; search: boolean; shared_locations: boolean; skip_last_msg_update_for_system_msgs: boolean; typing_events: b… |
stream-chat | AddUserGroupMembersOptions | type | { member_ids: string[]; as_admin?: boolean | undefined; team_id?: string | undefined; } |
stream-chat | ChannelSetterParameterType | type | Channel[] | Patch<Channel[]> |
stream-chat | GetBlockedUsersAPIResponse | type | APIResponse & { blocks: BlockedUserDetails[]; } |
stream-chat | GetRetentionPolicyResponse | type | APIResponse & { policies: RetentionPolicy[]; } |
stream-chat | MessageFlagsFiltersOptions | type | { channel_cid?: string | undefined; is_reviewed?: boolean | undefined; team?: string | undefined; user_id?: string | undefined; } |
stream-chat | PartialUpdateChannelFields | type | Partial<ChannelResponse> & { config_overrides?: Partial<ChannelConfigFields> | undefined; } |
stream-chat | PushProviderUpsertResponse | type | { push_provider: PushProvider; } |
stream-chat | QueryChannelsRequestOutput | type | Channel[] | QueryChannelsResponseWithChannels |
stream-chat | QueryMessageHistoryFilters | type | { message_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string> | undefined; user_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?… |
stream-chat | QueryMessageHistoryOptions | type | { limit?: number | undefined; next?: string | undefined; prev?: string | undefined; } |
stream-chat | QueryModerationConfigsSort | type | Sort<"created_at" | "updated_at" | "key">[] |
stream-chat | QuerySegmentTargetsOptions | type | { limit?: number | undefined; next?: string | undefined; } |
stream-chat | QueryTeamUsageStatsOptions | type | { month?: string | undefined; start_date?: string | undefined; end_date?: string | undefined; limit?: number | undefined; next?: string | undefined; } |
stream-chat | SetRetentionPolicyResponse | type | APIResponse & { policy: RetentionPolicy; } |
stream-chat | TruncateChannelAPIResponse | type | APIResponse & { channel: ChannelResponse; message?: MessageResponse | undefined; } |
Tanda tangan yang berubah
| export | Sebelum | Sesudah |
|---|---|---|
stream-chat · Role | "user" | "anonymous" | (string & {}) | "admin" | "guest" | "channel_member" | "channel_moderator" | interface |
stream-chat · User | CustomUserData & { id: string; anon?: boolean | undefined; banned?: boolean | undefined; blocked_user_ids?: string[] | undefined; channel_last_read_at?: string | undefined; created_at?: string | undefined; deactivated_at?: string | undefined; deleted_at?: string | undefined; image?: string | undefined; invisible?: boolean | undefined; language?: "" | TranslationLanguages | undefined; last_active?: string | undefined; name?: string | undefined; notifications_muted?: boolean | undefined; online?: boolean | undefined; privacy_settings?: PrivacySettings | undefined; push_notifications?: PushNotifi… | interface |
stream-chat · Event | CustomEventData & { type: EventTypes; ai_message?: string | undefined; ai_state?: AIState | undefined; channel?: ChannelResponse | undefined; channel_custom?: CustomChannelData | undefined; channel_id?: string | undefined; channel_member_count?: number | undefined; channel_type?: string | undefined; cid?: string | undefined; clear_history?: boolean | undefined; connection_id?: string | undefined; created_at?: string | undefined; deleted_for_me?: boolean | undefined; draft?: DraftResponse | undefined; first_unread_message_id?: string | undefined; hard_delete?: boolean | undefined; last_delivere… | ((({ type: "ai_indicator.clear"; } & AIIndicatorClearEvent) | ({ type: "ai_indicator.stop"; } & AIIndicatorStopEvent) | ({ type: "ai_indicator.update"; } & AIIndicatorUpdateEvent) | ({ type: "app.updated"; } & AppUpdatedEvent) | ({ type: "channel.created"; } & ChannelCreatedEvent) | ({ type: "channel.deleted"; } & ChannelDeletedEvent) | ({ type: "channel.forked"; } & ChannelForkedEvent) | ({ type: "channel.frozen"; } & ChannelFrozenEvent) | ({ type: "channel.hidden"; } & ChannelHiddenEvent) | ({ type: "channel.kicked"; } & ChannelKickedEvent) | ({ type: "channel.max_streak_changed"; } & MaxStr… |
stream-chat · Field | { short?: boolean | undefined; title?: string | undefined; value?: string | undefined; } | interface |
stream-chat · Action | { name?: string | undefined; style?: string | undefined; text?: string | undefined; type?: string | undefined; value?: string | undefined; } | interface |
stream-chat · MsgRef | { timestampMs: number; msgId: string; } | { timestamp: TimestampNS; msgId: string; } |
stream-chat · AIState | (string & {}) | "AI_STATE_ERROR" | "AI_STATE_CHECKING_SOURCES" | "AI_STATE_THINKING" | "AI_STATE_GENERATING" | (string & {}) | "AI_STATE_IDLE" | "AI_STATE_ERROR" | "AI_STATE_EXTERNAL_SOURCES" | "AI_STATE_THINKING" | "AI_STATE_GENERATING" | "AI_STATE_STOP" |
stream-chat · Automod | (string & {}) | "disabled" | "simple" | "AI" | "disabled" | "simple" | "AI" |
stream-chat · Command | { args: string; description: string; name: string; set: string; created_at?: string | undefined; updated_at?: string | undefined; } | interface |
stream-chat · LLMRule | { label: string; description: string; action: ModerationActionType; severity_rules?: LLMSeverityRule[] | undefined; } | interface |
stream-chat · LogLevel | "error" | "info" | "warn" | any |
stream-chat · Reaction | CustomReactionData & { type: string; message_id?: string | undefined; score?: number | undefined; user?: UserResponse | null | undefined; user_id?: string | undefined; emoji_code?: string | undefined; } | interface |
stream-chat · LLMConfig | { rules: LLMRule[]; severity_descriptions?: Record<ModerationSeverity, string> | undefined; app_context?: string | undefined; } | interface |
stream-chat · PollState | Omit<PollResponse, "id" | "own_votes"> & { lastActivityAt: Date; maxVotedOptionIds: string[]; ownVotesByOptionId: Record<string, PollVote>; ownAnswer?: PollAnswer | undefined; } | Omit<PollResponseData, "id" | "own_votes"> & { lastActivityAt: TimestampNS; maxVotedOptionIds: string[]; ownVotesByOptionId: Record<string, PollVoteResponseData>; ownAnswer?: PollVoteResponseData | undefined; } |
stream-chat · Attachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | interface |
stream-chat · BanOptions | { duration: number; reason: string; shadow_ban: boolean; ip_ban: boolean; } | interface |
stream-chat · Thresholds | { explicit?: Partial<{ block: number; flag: number; }> | undefined; spam?: Partial<{ block: number; flag: number; }> | undefined; toxic?: Partial<{ block: number; flag: number; }> | undefined; } | interface |
stream-chat · timeLeftMs | (remindAt: number): number | (remindAt: TimestampNS): number |
stream-chat · APIResponse | { duration: string; blocklist?: BlockListResponse | undefined; } | { duration: string; } |
stream-chat · AppDefaults | { get_or_create_channel: { members: PagerDefaults; messages: PagerDefaults; }; query_channels: { limit: number; max_limit: number; member_limit: number; message_limit: number; }; } | interface |
stream-chat · AutomodRule | { action: ModerationActionType; label: string; threshold: number; } | interface |
stream-chat · ChannelMute | { user: UserResponse; channel?: ChannelResponse | undefined; created_at?: string | undefined; expires?: string | undefined; updated_at?: string | undefined; } | interface |
stream-chat · LinkPreview | OGAttachment & { status: LinkPreviewStatus; } | Omit<Attachment, "og_scrape_url"> & Required<Pick<Attachment, "og_scrape_url">> & { status: LinkPreviewStatus; } |
stream-chat · OwnUserBase | { channel_mutes: ChannelMute[]; devices: Device[]; mutes: Mute[]; total_unread_count: number; unread_channels: number; unread_count: number; unread_threads: number; invisible?: boolean | undefined; privacy_settings?: PrivacySettings | undefined; push_preferences?: PushPreferencesResponse | undefined; roles?: string[] | undefined; total_unread_count_by_team?: Record<string, number> | null | undefined; } | { total_unread_count: number; unread_channels: number; unread_count: number; unread_threads: number; invisible: boolean; channel_mutes: ChannelMute[]; devices: DeviceResponse[]; mutes: UserMuteResponse[]; latest_hidden_channels?: string[] | undefined; privacy_settings?: PrivacySettingsResponse | undefined; push_preferences?: PushPreferencesResponse | undefined; total_unread_count_by_team?: Record<string, number> | undefined; } |
stream-chat · PendingTask | { channelId?: string | undefined; channelType?: string | undefined; messageId?: string | undefined; id?: number | undefined; threadId?: string | undefined; } & ({ payload: [messageID: string, reaction: Reaction, options?: SendReactionOptions | undefined]; type: "send-reaction"; } | { payload: [message: LocalMessage | Partial<MessageResponse>, partialUserOrUserId?: string | { id: string; } | undefined, options?: UpdateMessageOptions | undefined]; type: "update-message"; } | { payload: [messageID: string, optionsOrHardDelete?: boolean | DeleteMessageOptions | undefined]; type: "delete-message"; … | { channelId?: string | undefined; channelType?: string | undefined; messageId?: string | undefined; id?: number | undefined; threadId?: string | undefined; } & ({ payload: [request: SendMessageRequest, requestOptions?: StreamRequestOptions | undefined]; type: "send-message"; } | { payload: [pathParams: { id: string; }, request: SendReactionRequest, requestOptions?: StreamRequestOptions | undefined]; type: "send-reaction"; } | { payload: [request: CreateDraftRequest, requestOptions?: StreamRequestOptions | undefined]; type: "create-draft"; } | { payload: [request?: { parent_id?: string | undefi… |
stream-chat · ThreadState | { active: boolean; channel: Channel; createdAt: Date; custom: CustomThreadData; deletedAt: Date | null; isLoading: boolean; isStateStale: boolean; pagination: ThreadRepliesPagination; parentMessage: LocalMessage; participants: { channel_cid: string; created_at: string; last_read_at: string; last_thread_message_at?: string | undefined; left_thread_at?: string | undefined; thread_id?: string | undefined; user?: UserResponse | undefined; user_id?: string | undefined; }[] | undefined; read: ThreadReadState; replies: LocalMessage[]; replyCount: number; title: string; updatedAt: Date | null; } | { active: boolean; channel: Channel; createdAt: TimestampNS; custom: CustomThreadData; deletedAt: TimestampNS | null; isLoading: boolean; isStateStale: boolean; parentMessage: LocalMessage; participants: ThreadParticipant[] | undefined; read: ThreadReadState; replyCount: number; title: string; updatedAt: TimestampNS | null; } |
stream-chat · UserFilters | { id?: PrimitiveFilter<string> | RequireOnlyOne<{ $autocomplete?: string | undefined; } & { $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$autocomplete"> | undefined; name?: PrimitiveFilter<string | undefined> | RequireOnlyOne<{ $autocomplete?: string | undefined; } & { $eq?: PrimitiveF… | { [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; }, "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"> | null | undefined; created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $exists: boolean; $gt: string | Date; $g… |
stream-chat · UserOptions | { include_deactivated_users?: boolean | undefined; limit?: number | undefined; offset?: number | undefined; presence?: boolean | undefined; } | { limit?: number | undefined; offset?: number | undefined; id_gte?: string | undefined; id_gt?: string | undefined; id_lte?: string | undefined; id_lt?: string | undefined; presence?: boolean | undefined; include_deactivated_users?: boolean | undefined; } |
stream-chat · AITextConfig | { enabled: boolean; rules: AITextRule[]; async?: boolean | undefined; profile?: string | undefined; severity_rules?: AITextSeverityRule[] | undefined; } | interface |
stream-chat · DraftMessage | { id: string; text: string; attachments?: Attachment[] | undefined; custom?: {} | undefined; html?: string | undefined; mentioned_users?: string[] | undefined; mentioned_channel?: boolean | undefined; mentioned_here?: boolean | undefined; mentioned_group_ids?: string[] | undefined; mentioned_groups?: UserGroupResponse[] | undefined; mentioned_roles?: string[] | undefined; mml?: string | undefined; parent_id?: string | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; shared_location?: StaticLocationPayload | LiveLocationPayload | undefined; show_in_channel?: bool… | DraftPayloadResponse & Partial<Pick<MessageResponse, "shared_location" | "mentioned_channel" | "mentioned_group_ids" | "mentioned_groups" | "mentioned_here" | "mentioned_roles">> |
stream-chat · EventHandler | (event: Event) => void | (event: T extends "all" ? Event : Extract<{ type: "ai_indicator.clear"; } & AIIndicatorClearEvent & { received_at?: TimestampNS | undefined; }, { type: T; }> | Extract<{ type: "ai_indicator.stop"; } & AIIndicatorStopEvent & { received_at?: TimestampNS | undefined; }, { type: T; }> | Extract<{ type: "ai_indicator.update"; } & AIIndicatorUpdateEvent & { received_at?: TimestampNS | undefined; }, { type: T; }> | Extract<{ type: "app.updated"; } & AppUpdatedEvent & { received_at?: TimestampNS | undefined; }, { type: T; }> | Extract<{ type: "channel.created"; } & ChannelCreatedEvent & { received_at?… |
stream-chat · LocalMessage | Omit<MessageResponseBase, "created_at" | "deleted_at" | "pinned_at" | "status" | "updated_at"> & { created_at: Date; deleted_at: Date | null; pinned_at: Date | null; status: string; updated_at: Date; } & { error?: ErrorFromResponse<APIErrorResponse> | null | undefined; quoted_message?: LocalMessageBase | null | undefined; } | MessageResponse & { status: string; error?: StreamAPIError<APIError> | undefined; user_id?: string | undefined; } |
stream-chat · MessageLabel | "deleted" | "ephemeral" | "error" | "regular" | "reply" | "system" | "error" | "deleted" | "ephemeral" | "regular" | "reply" | "system" |
stream-chat · MuteResponse | { user: UserResponse; created_at?: string | undefined; expires?: string | undefined; target?: UserResponse | undefined; updated_at?: string | undefined; } | interface |
stream-chat · Notification | { id: string; message: string; createdAt: number; origin: NotificationOrigin; actions?: NotificationAction[] | undefined; severity?: NotificationSeverity | undefined; type?: string | undefined; duration?: number | undefined; metadata?: Record<string, unknown> | undefined; tags?: string[] | undefined; originalError?: Error | undefined; } | { id: string; message: string; createdAt: number; origin: NotificationOrigin; actions?: NotificationAction[] | undefined; severity?: NotificationSeverity | undefined; type?: (string & {}) | CoreNotificationType | undefined; duration?: number | undefined; metadata?: Record<string, unknown> | undefined; tags?: string[] | undefined; originalError?: Error | undefined; } |
stream-chat · OGAttachment | { og_scrape_url: string; asset_url?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; image_url?: string | undefined; text?: string | undefined; thumb_url?: string | undefined; title?: string | undefined; title_link?: string | undefined; type?: string | undefined; } | Omit<Attachment, "og_scrape_url"> & Required<Pick<Attachment, "og_scrape_url">> |
stream-chat · PollResponse | CustomPollData & PollEnrichData & { created_at: string; created_by: UserResponse | null; created_by_id: string; enforce_unique_vote: boolean; id: string; max_votes_allowed: number; name: string; options: PollOption[]; updated_at: string; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; description_i18n?: TranslatedField | undefined; is_closed?: boolean | undefined; name_i18n?: TranslatedField | undefined; voting_visibility?: VotingVisibility | undefined; } | interface |
stream-chat · PushProvider | "apn" | "firebase" | "huawei" | "xiaomi" | "firebase" | "apn" | "huawei" | "xiaomi" |
stream-chat · SyncResponse | APIResponse & { events: Event[]; inaccessible_cids?: string[] | undefined; } | interface |
stream-chat · UserResponse | CustomUserData & { id: string; anon?: boolean | undefined; banned?: boolean | undefined; blocked_user_ids?: string[] | undefined; channel_last_read_at?: string | undefined; created_at?: string | undefined; deactivated_at?: string | undefined; deleted_at?: string | undefined; image?: string | undefined; invisible?: boolean | undefined; language?: "" | TranslationLanguages | undefined; last_active?: string | undefined; name?: string | undefined; notifications_muted?: boolean | undefined; online?: boolean | undefined; privacy_settings?: PrivacySettings | undefined; push_notifications?: PushNotifi… | interface |
stream-chat · isVoteAnswer | (vote: PollVote | PollAnswer): vote is PollAnswer | (vote: any): vote is RequireLiteral<PollVoteResponseData, "answer_text" | "is_answer"> |
stream-chat · AIImageConfig | { enabled: boolean; rules: AIImageRule[]; async?: boolean | undefined; } | interface |
stream-chat · BlockListRule | { action: ModerationActionType; name?: string | undefined; } | interface |
stream-chat · ChannelConfig | ChannelConfigFields & CreatedAtUpdatedAt & { commands?: CommandVariants[] | undefined; } | { requestHandlers?: { deleteMessageRequest?: OperationRequestFn<"delete"> | undefined; markReadRequest?: CustomMarkReadRequestFn | undefined; sendMessageRequest?: OperationRequestFn<"send"> | undefined; retrySendMessageRequest?: OperationRequestFn<"retry"> | undefined; updateMessageRequest?: OperationRequestFn<"update"> | undefined; } | undefined; typingEvents: { enabled: boolean; }; readEvents: { enabled: boolean; localUnreadCountEnabled: boolean; }; replies: { enabled: boolean; }; userMessageReminders: { enabled: boolean; }; deliveryEvents: { enabled: boolean; }; availableCommands: Command[]… |
stream-chat · DraftResponse | { channel_cid: string; created_at: string; message: DraftMessage; channel?: ChannelResponse | undefined; parent_id?: string | undefined; parent_message?: MessageResponseBase | undefined; quoted_message?: MessageResponseBase | undefined; } | interface |
stream-chat · FileReference | Pick<File, "type" | "name" | "size"> & { uri: string; height?: number | undefined; width?: number | undefined; duration?: number | undefined; waveform_data?: number[] | undefined; thumb_url?: string | undefined; } | FileReferenceBase & Pick<File, "name" | "size"> & { height?: number | undefined; width?: number | undefined; duration?: number | undefined; waveform_data?: number[] | undefined; thumb_url?: string | undefined; } |
stream-chat · GiphyVersions | "original" | "fixed_height" | "fixed_height_still" | "fixed_height_downsampled" | "fixed_width" | "fixed_width_still" | "fixed_width_downsampled" | keyof Images |
stream-chat · MemberFilters | { banned?: boolean | { $eq?: boolean | undefined; } | undefined; channel_role?: Role | { $eq?: Role | undefined; } | undefined; cid?: string | { $eq?: string | undefined; } | undefined; created_at?: string | { $eq?: string | undefined; $gt?: string | undefined; $gte?: string | undefined; $lt?: string | undefined; $lte?: string | undefined; } | undefined; id?: string | RequireOnlyOne<{ $eq?: string | undefined; $in?: string[] | undefined; }, "$eq" | "$in"> | undefined; invite?: InviteStatus | { $eq?: InviteStatus | undefined; } | undefined; is_moderator?: boolean | RequireOnlyOne<{ $eq?: boolea… | Filters<{ banned: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type: string; operators: "$eq"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomMemberData; operators: "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$autocomplete" | "$q"; }; id: { type: string; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; invite: { type: string; operators: "$eq"; }; is_moderator: { type: boolean; operators: "$e… |
stream-chat · PagerDefaults | { limit: number; } | interface |
stream-chat · ReminderEvent | { cid: string; created_at: string; message_id: string; reminder: ReminderResponse; type: EventTypes; user_id: string; } | ({ type: "notification.reminder_due"; } & ReminderNotificationEvent & { received_at?: TimestampNS | undefined; }) | ({ type: "reminder.created"; } & ReminderCreatedEvent & { received_at?: TimestampNS | undefined; }) | ({ type: "reminder.deleted"; } & ReminderDeletedEvent & { received_at?: TimestampNS | undefined; }) | ({ type: "reminder.updated"; } & ReminderUpdatedEvent & { received_at?: TimestampNS | undefined; }) |
stream-chat · ReminderState | { channel_cid: string; created_at: Date; message: MessageResponse | null; message_id: string; remind_at: Date | null; timeLeftMs: number | null; updated_at: Date; user: UserResponse | null; user_id: string; } | { channel_cid: string; created_at: TimestampNS; message: MessageResponse | null; message_id: string; remind_at: TimestampNS | null; timeLeftMs: number | null; updated_at: TimestampNS; user: UserResponse | null; user_id: string; } |
stream-chat · SearchPayload | Omit<SearchOptions, "sort"> & { client_id?: string | undefined; connection_id?: string | undefined; filter_conditions?: ChannelFilters | undefined; message_filter_conditions?: MessageFilters | undefined; message_options?: MessageOptions | undefined; query?: string | undefined; sort?: { direction: AscDesc; field: "created_at" | "updated_at" | "id" | "attachments" | "parent_id" | "pinned" | "text" | "type" | "reply_count" | "attachments.type" | "mentioned_users.id" | "user.id" | "relevance"; }[] | undefined; } | interface |
stream-chat · SearchWarning | { channel_search_cids: string[]; channel_search_count: number; warning_code: number; warning_description: string; } | interface |
stream-chat · ThreadFilters | { channel_cid?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string> | undefined; parent_message_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | unde… | { [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; $autocomplete: string | number | boolean | Date; $q: string | number | boolean | Date; }, "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$autocomplete" | "$q"> | null | undefined; c… |
stream-chat · formatMessage | (message: MessageResponseBase | MessageResponse | LocalMessage): LocalMessage | (message: MessageResponse | LocalMessage): LocalMessage |
stream-chat · BanUserOptions | UnBanUserOptions & { ban_from_future_channels?: boolean | undefined; banned_by?: UserResponse | undefined; banned_by_id?: string | undefined; ip_ban?: boolean | undefined; reason?: string | undefined; timeout?: number | undefined; delete_messages?: MessageDeletionStrategy | undefined; delete_reactions?: boolean | undefined; } | { ban_from_future_channels?: boolean | undefined; reason?: string | undefined; shadow?: boolean | undefined; delete_messages?: DeleteMessages | undefined; channel_cid?: string | undefined; delete_reactions?: boolean | undefined; ip_ban?: boolean | undefined; timeout?: number | undefined; } |
stream-chat · ChannelFilters | { app_banned?: "only" | "excluded" | undefined; has_unread?: boolean | undefined; archived?: boolean | undefined; invite?: "pending" | "accepted" | "rejected" | { $eq?: "pending" | "accepted" | "rejected" | undefined; } | undefined; 'member.user.name'?: string | RequireOnlyOne<{ $autocomplete?: string | undefined; $eq?: string | undefined; }, "$eq" | "$autocomplete"> | undefined; members?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<st… | { [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; $autocomplete: string | number | boolean | Date; $q: string | number | boolean | Date; }, "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$autocomplete" | "$q"> | null | undefined; t… |
stream-chat · ChannelOptions | { limit?: number | undefined; member_limit?: number | undefined; message_limit?: number | undefined; offset?: number | undefined; presence?: boolean | undefined; state?: boolean | undefined; user_id?: string | undefined; watch?: boolean | undefined; predefined_filter?: string | undefined; filter_values?: Record<string, unknown> | undefined; sort_values?: Record<string, unknown> | undefined; } | { limit?: number | undefined; offset?: number | undefined; member_custom_include?: string[] | undefined; predefined_filter?: string | undefined; include_active_member_count?: boolean | undefined; include_scheduled_messages?: boolean | undefined; member_limit?: number | undefined; message_limit?: number | undefined; presence?: boolean | undefined; state?: boolean | undefined; watch?: boolean | undefined; filter_values?: Record<string, any> | undefined; sort_values?: Record<string, any> | undefined; } |
stream-chat · ConnectionOpen | { connection_id: string; cid?: string | undefined; created_at?: string | undefined; received_at?: string | undefined; me?: OwnUserResponse | undefined; type?: string | undefined; } | ({ type: "connection.ok"; } & ConnectedEvent & { received_at?: TimestampNS | undefined; }) | ({ type: "health.check"; } & HealthCheckEvent & { received_at?: TimestampNS | undefined; }) |
stream-chat · FileAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "file"; } |
stream-chat · MessageFilters | { 'attachments.type'?: PrimitiveFilter<string | undefined> | RequireOnlyOne<{ $eq: PrimitiveFilter<string | undefined>; $in: PrimitiveFilter<string | undefined>[]; }, "$eq" | "$in">; 'mentioned_users.id'?: RequireOnlyOne<{ $contains: PrimitiveFilter<string>; }, "$contains"> | undefined; text?: PrimitiveFilter<string | undefined> | RequireOnlyOne<{ $autocomplete?: string | undefined; $q?: string | undefined; } & { $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?: PrimitiveFilter<… | { [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $eq: string | number | boolean | Date | null; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; }, "$eq" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"> | null | undefined; type?: string | RequireOnlyOne<{ $eq: string | null; $exists: boolean; $gt: string; $gte: string; $in: string[]; $lt: string; $lte: string; }, "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"… |
stream-chat · MessageOptions | { include_thread_participants?: boolean | undefined; } | interface |
stream-chat · PaginatorState | { hasNext: boolean; hasPrev: boolean; isLoading: boolean; items: T[] | undefined; lastQueryError?: Error | undefined; cursor?: Cursor | undefined; offset?: number | undefined; } | { hasMoreHead: boolean; hasMoreTail: boolean; isLoading: boolean; items: T[] | undefined; lastQueryError?: Error | undefined; cursor?: PaginatorCursor | undefined; offset?: number | undefined; } |
stream-chat · UserSuggestion | BaseSuggestion & CustomUserData & { id: string; anon?: boolean | undefined; banned?: boolean | undefined; blocked_user_ids?: string[] | undefined; channel_last_read_at?: string | undefined; created_at?: string | undefined; deactivated_at?: string | undefined; deleted_at?: string | undefined; image?: string | undefined; invisible?: boolean | undefined; language?: "" | TranslationLanguages | undefined; last_active?: string | undefined; name?: string | undefined; notifications_muted?: boolean | undefined; online?: boolean | undefined; privacy_settings?: PrivacySettings | undefined; push_notificat… | BaseSuggestion & UserResponse & TokenizationPayload & { mentionType: "user"; } |
stream-chat · AudioAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "audio"; } |
stream-chat · AutomodBehavior | (string & {}) | "flag" | "block" | "shadow_block" | "flag" | "block" | "shadow_block" |
stream-chat · BlockListConfig | { enabled: boolean; rules: BlockListRule[]; async?: boolean | undefined; } | interface |
stream-chat · ChannelResponse | CustomChannelData & { cid: string; disabled: boolean; frozen: boolean; id: string; type: string; blocked?: boolean | undefined; auto_translation_enabled?: boolean | undefined; auto_translation_language?: TranslationLanguages | undefined; hide_messages_before?: string | undefined; config?: ChannelConfigWithInfo | undefined; cooldown?: number | undefined; created_at?: string | undefined; created_by?: UserResponse | null | undefined; created_by_id?: string | undefined; deleted_at?: string | undefined; filter_tags?: string[] | undefined; hidden?: boolean | undefined; invites?: string[] | undefined… | interface |
stream-chat · ChatPreferences | { channel_mentions?: PushPreferenceLevel | undefined; default_preference?: PushPreferenceLevel | undefined; direct_mentions?: PushPreferenceLevel | undefined; group_mentions?: PushPreferenceLevel | undefined; here_mentions?: PushPreferenceLevel | undefined; role_mentions?: PushPreferenceLevel | undefined; thread_replies?: PushPreferenceLevel | undefined; } | interface |
stream-chat · FlagUserOptions | { reason: string; } | interface |
stream-chat · GiphyAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "giphy"; } |
stream-chat · ImageAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "image"; } |
stream-chat · MessageResponse | CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; restricted_visibility?: string[] | undefined; show_in_channel?: boolean | undefined; silent?: boolean | undefined; text?: string | undefined; type?: MessageLabel | undefined; user?: UserResponse | null | undefined; user_id?: string | undefined; } & { type: Mess… | interface |
stream-chat · OwnUserResponse | CustomUserData & { id: string; anon?: boolean | undefined; banned?: boolean | undefined; blocked_user_ids?: string[] | undefined; channel_last_read_at?: string | undefined; created_at?: string | undefined; deactivated_at?: string | undefined; deleted_at?: string | undefined; image?: string | undefined; invisible?: boolean | undefined; language?: "" | TranslationLanguages | undefined; last_active?: string | undefined; name?: string | undefined; notifications_muted?: boolean | undefined; online?: boolean | undefined; privacy_settings?: PrivacySettings | undefined; push_notifications?: PushNotifi… | interface |
stream-chat · ReactionFilters | { user_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?: PrimitiveFilter<string | undefined>[] | undefined; $lt?: PrimitiveFilter<string | undefined>; $lte?: PrimitiveFilter<string | undefined>; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string | undefined>; type?: PrimitiveFilter<string> | RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: Primitive… | { created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $exists: boolean; $gt: string | Date; $gte: string | Date; $in: (string | Date)[]; $lt: string | Date; $lte: string | Date; }, "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"> | null | undefined; type?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; user_id?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; } & QueryLogicalOperators<{ created_at: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $e… |
stream-chat · ReminderFilters | { channel_cid?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string> | undefined; created_at?: PrimitiveFilter<string> | RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFi… | { channel_cid?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $gt: string | Date; $gte: string | Date; $lt: string | Date; $lte: string | Date; }, "$eq" | "$gt" | "$gte" | "$lt" | "$lte"> | null | undefined; expires_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $exists: boolean; $gt: string | Date; $gte: string | Date; $lt: string | Date; $lte: string | Date; }, "$eq" | "$exists" | "$gt" | "$gte" | "$lt" | "$lte"> | null | undefined; message_id?: stri… |
stream-chat · ReminderOptions | { data: ReminderResponseBaseOrResponse; config?: ReminderTimerConfig | undefined; } | { data: ReminderResponseData; config?: ReminderTimerConfig | undefined; } |
stream-chat · RuleBuilderRule | { id: string; rule_type: "user" | "content"; conditions?: RuleBuilderCondition[] | undefined; logic?: "AND" | "OR" | undefined; groups?: RuleBuilderConditionGroup[] | undefined; action: RuleBuilderAction; cooldown_period?: string | undefined; } | interface |
stream-chat · VideoAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "video"; } |
stream-chat · extractPollData | (pollResponse: PollResponse): PollData | (pollResponse: PollResponseData): UpdatePollRequest |
stream-chat · BlockListOptions | { behavior: AutomodBehavior; blocklist: string; } | interface |
stream-chat · DBUpsertPollType | { poll: PollResponse; execute?: boolean | undefined; } | { poll: PollResponseData; execute?: boolean | undefined; } |
stream-chat · FileUploadConfig | { allowed_file_extensions?: string[] | null | undefined; allowed_mime_types?: string[] | null | undefined; blocked_file_extensions?: string[] | null | undefined; blocked_mime_types?: string[] | null | undefined; size_limit?: number | null | undefined; } | interface |
stream-chat · GetDraftResponse | APIResponse & { draft: DraftResponse; } | interface |
stream-chat · GetThreadOptions | { member_limit?: number | undefined; participant_limit?: number | undefined; reply_limit?: number | undefined; watch?: boolean | undefined; } | { watch?: boolean | undefined; connection_id?: string | undefined; reply_limit?: number | undefined; participant_limit?: number | undefined; member_limit?: number | undefined; } |
stream-chat · ModerationAction | "flag" | "bounce" | "remove" | "shadow" | "shadow" | "flag" | "remove" | "bounce" | "bounce_flag" | "bounce_remove" |
stream-chat · PaginatorOptions | { debounceMs?: number | undefined; pageSize?: number | undefined; } | { declarativeConfig?: DeclarativePaginatorConfig | undefined; debounceMs?: number | undefined; stateThrottleMs?: number | undefined; hasPaginationQueryShapeChanged?: PaginationQueryShapeChangeIdentifier<any> | undefined; deriveCursor?: CursorDerivator<T, Q> | undefined; doRequest?: ((queryParams: Q) => Promise<DoRequestResponse<T>>) | undefined; initialCursor?: PaginatorCursor | undefined; initialOffset?: number | undefined; itemIndex?: ItemIndexApi<T> | undefined; createItemIndex?: ((owner: BasePaginator<T, Q, unknown>) => ItemIndexApi<T>) | undefined; itemOrderComparator?: ((a: T, b: T) => n… |
stream-chat · ReactionResponse | CustomReactionData & { type: string; message_id?: string | undefined; score?: number | undefined; user?: UserResponse | null | undefined; user_id?: string | undefined; emoji_code?: string | undefined; } & { created_at: string; message_id: string; updated_at: string; } | interface |
stream-chat · SearchSourceType | "channels" | (string & {}) | "messages" | "users" | (string & {}) | "channels" | "users" | "messages" |
stream-chat · TypingStartEvent | CustomEventData & { type: EventTypes; ai_message?: string | undefined; ai_state?: AIState | undefined; channel?: ChannelResponse | undefined; channel_custom?: CustomChannelData | undefined; channel_id?: string | undefined; channel_member_count?: number | undefined; channel_type?: string | undefined; cid?: string | undefined; clear_history?: boolean | undefined; connection_id?: string | undefined; created_at?: string | undefined; deleted_for_me?: boolean | undefined; draft?: DraftResponse | undefined; first_unread_message_id?: string | undefined; hard_delete?: boolean | undefined; last_delivere… | interface |
stream-chat · UpdateFieldsData | Partial<Omit<{ id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; user_id?: string | undefined; voting_visibility?: VotingVisibility | undefined; }, "options">> & { options?: PollComposerOptionUpdate | undefined; } | Partial<Omit<{ id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; voting_visibility?: VotingVisibility | undefined; }, "options">> & { options?: PollComposerOptionUpdate | undefined; } |
stream-chat · VotingVisibility | VotingVisibility | "anonymous" | "public" |
stream-chat · getCommandByName | (searchSource: CommandSearchSource, commandName?: string | undefined): CommandResponse | undefined | (searchSource: CommandSearchSource, commandName?: string | undefined): Command | undefined |
stream-chat · BlockListResponse | BlockList & { created_at?: string | undefined; id?: string | undefined; owner_user_id?: string | undefined; type?: string | undefined; updated_at?: string | undefined; } | interface |
stream-chat · BlocklistBehavior | (string & {}) | "flag" | "block" | "shadow_block" | "flag" | "block" |
stream-chat · CommandSuggestion | BaseSuggestion & Partial<CreatedAtUpdatedAt> & { args?: string | undefined; description?: string | undefined; name?: CommandVariants | undefined; set?: CommandVariants | undefined; } | BaseSuggestion & Command |
stream-chat · DBUpsertReadsType | { cid: string; reads: ReadResponse[]; execute?: boolean | undefined; } | { cid: string; reads: ReadStateResponse[]; execute?: boolean | undefined; } |
stream-chat · GetConfigResponse | { config: ModerationConfigResponse; } | interface |
stream-chat · ModerationPayload | { created_at: string; custom?: Record<string, any> | undefined; images?: string[] | undefined; texts?: string[] | undefined; videos?: string[] | undefined; } | interface |
stream-chat · PartialPollUpdate | { set?: Partial<PollData> | undefined; unset?: ("id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility")[] | undefined; } | { set?: Partial<UpdatePollRequest> | undefined; unset?: (keyof UpdatePollRequest)[] | undefined; } |
stream-chat · PollComposerState | { data: { id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; user_id?: string | undefined; voting_visibility?: VotingVisibility | undefined; }; errors: Partial<Omit<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", string>,… | { data: { id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; voting_visibility?: VotingVisibility | undefined; }; errors: Partial<Omit<Record<keyof CreatePollRequest, PollComposerValidationError>, "options"> & { options?: Record<string, PollComposerValidationError> | undefined; }>; } |
stream-chat · QueryPollsFilters | { id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string> | undefined; user_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?: Primit… | { [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; $autocomplete: string | number | boolean | Date; $q: string | number | boolean | Date; }, "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$autocomplete" | "$q"> | null | undefined; c… |
stream-chat · QueryVotesFilters | { id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string> | undefined; option_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFilter<string | undefined>; $in?: Prim… | { created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $gt: string | Date; $gte: string | Date; $lt: string | Date; $lte: string | Date; }, "$eq" | "$gt" | "$gte" | "$lt" | "$lte"> | null | undefined; id?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; is_answer?: boolean | RequireOnlyOne<{ $eq: boolean | null; }, "$eq"> | null | undefined; option_id?: string | RequireOnlyOne<{ $eq: string | null; $exists: boolean; $in: string[]; }, "$eq" | "$exists" | "$in"> | null | undefined; poll_id?: string | RequireOnlyOne<{ $eq: str… |
stream-chat · RuleBuilderAction | { type: string; ban_options?: BanOptions | undefined; flag_user_options?: FlagUserOptions | undefined; } | interface |
stream-chat · TextComposerState | { mentionedUsers: UserResponse[]; mentions?: MentionEntity[] | undefined; selection: TextSelection; text: string; command?: CommandResponse | null | undefined; suggestions?: Suggestions<T> | undefined; } | { mentionedUsers: UserResponse[]; mentions?: MentionEntity[] | undefined; selection: TextSelection; text: string; command?: Command | null | undefined; suggestions?: Suggestions<T> | undefined; } |
stream-chat · UserGroupResponse | { id: string; name: string; created_at: string; updated_at: string; description?: string | undefined; team_id?: string | undefined; members?: UserGroupMemberResponse[] | undefined; created_by?: string | undefined; } | interface |
stream-chat · UserMentionEntity | CustomUserData & { id: string; anon?: boolean | undefined; banned?: boolean | undefined; blocked_user_ids?: string[] | undefined; channel_last_read_at?: string | undefined; created_at?: string | undefined; deactivated_at?: string | undefined; deleted_at?: string | undefined; image?: string | undefined; invisible?: boolean | undefined; language?: "" | TranslationLanguages | undefined; last_active?: string | undefined; name?: string | undefined; notifications_muted?: boolean | undefined; online?: boolean | undefined; privacy_settings?: PrivacySettings | undefined; push_notifications?: PushNotifi… | UserResponse & { mentionType: "user"; } |
stream-chat · AnyLocalAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { localMetadata: LocalAttachmentMetadata<CustomLocalMetadata> & BaseLocalAttachmentMetadata; } |
stream-chat · CommandSendability | { command: CommandResponse; ready: boolean; reason?: (string & {}) | undefined; metadata?: Record<string, unknown> | undefined; } | { command: Command; ready: boolean; reason?: (string & {}) | undefined; metadata?: Record<string, unknown> | undefined; } |
stream-chat · CompositionContext | Thread | Channel | LocalMessageWithLegacyThreadId | Channel | Thread | LocalMessage |
stream-chat · CooldownTimerState | { cooldownConfigSeconds: number; canSkipCooldown: boolean; ownLatestMessageDate?: Date | undefined; cooldownRemaining: number; } | { cooldownConfigSeconds: number; canSkipCooldown: boolean; ownLatestMessageTimestamp?: TimestampNS | undefined; cooldownRemaining: number; } |
stream-chat · DBGetReactionsType | { messageId: string; filters?: Pick<ReactionFilters, "type"> | undefined; sort?: ReactionSort | undefined; limit?: number | undefined; } | { messageId: string; filters?: ({ created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $exists: boolean; $gt: string | Date; $gte: string | Date; $in: (string | Date)[]; $lt: string | Date; $lte: string | Date; }, "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"> | null | undefined; type?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; user_id?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; } & QueryLogicalOperators<{ created_at: string | Date | RequireOnlyOne… |
stream-chat · LastComposerChange | { draftUpdate: number | null; stateUpdate: number; } | { draftUpdate: TimestampNS | null; stateUpdate: TimestampNS; } |
stream-chat · ModerationResponse | { action: ModerationAction; original_text: string; } | interface |
stream-chat · PollOptionResponse | CustomPollData & { created_at: string; id: string; poll_id: string; position: number; text: string; updated_at: string; vote_count: number; text_i18n?: TranslatedField | undefined; votes?: PollVote[] | undefined; } | interface |
stream-chat · QueryPollsResponse | { polls: PollResponse[]; next?: string | undefined; } | interface |
stream-chat · SendMessageOptions | { force_moderation?: boolean | undefined; is_pending_message?: boolean | undefined; keep_channel_hidden?: boolean | undefined; pending?: boolean | undefined; pending_message_metadata?: Record<string, string> | undefined; skip_enrich_url?: boolean | undefined; skip_push?: boolean | undefined; } | { include_channel_context?: boolean | undefined; include_mentioned_members?: boolean | undefined; keep_channel_hidden?: boolean | undefined; scheduled_at?: Date | undefined; skip_enrich_url?: boolean | undefined; skip_push?: boolean | undefined; } |
stream-chat · TextRuleParameters | { threshold: number; time_window: string; harm_labels?: string[] | undefined; llm_harm_labels?: Record<string, string> | undefined; contains_url?: boolean | undefined; severity?: string | undefined; blocklist_match?: string[] | undefined; } | interface |
stream-chat · ThreadManagerState | { active: boolean; wasActivatedAtLeastOnce: boolean; isThreadOrderStale: boolean; lastConnectionDropAt: Date | null; pagination: ThreadManagerPagination; ready: boolean; threads: Thread[]; unreadThreadCount: number; unseenThreadIds: string[]; } | { active: boolean; wasActivatedAtLeastOnce: boolean; isThreadOrderStale: boolean; unreadThreadCount: number; unseenThreadIds: string[]; } |
stream-chat · UserRuleParameters | { max_age: string; } | interface |
stream-chat · ChannelManagerState | { channels: Channel[]; initialized: boolean; pagination: ChannelManagerPagination; error: Error | undefined; } | { paginators: ChannelPaginator[]; } |
stream-chat · ChannelStateOptions | RequestOptions & { offlineMode?: boolean | undefined; skipInitialization?: string[] | undefined; skipHydration?: boolean | undefined; withResponse?: boolean | undefined; } | { offlineMode?: boolean | undefined; skipHydration?: boolean | undefined; withResponse?: boolean | undefined; } |
stream-chat · CreateDraftResponse | APIResponse & { draft: DraftResponse; } | interface |
stream-chat · ImageRuleParameters | { threshold: number; time_window: string; harm_labels: string[]; } | interface |
stream-chat · LiveLocationPreview | Omit<LiveLocationPayload, "end_at"> & { durationMs?: number | undefined; } | Omit<SharedLocation, "end_at"> & { durationMs?: number | undefined; message_id?: string | undefined; } |
stream-chat · LocalFileAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "file"; } & { localMetadata: LocalAttachmentUploadMetadata & CustomLocalMetadata & BaseLocalAttachmentMetadata; } |
stream-chat · NotificationOptions | Partial<Pick<Notification, "type" | "severity" | "actions" | "metadata" | "tags" | "originalError">> & { duration?: number | undefined; } | Partial<Pick<Notification, "type" | "metadata" | "tags" | "actions" | "severity" | "originalError">> & { duration?: number | undefined; } |
stream-chat · QueryDraftsResponse | APIResponse & { drafts: DraftResponse[]; } & Omit<Pager, "limit"> | interface |
stream-chat · QueryMembersOptions | { created_at_after?: string | undefined; created_at_after_or_equal?: string | undefined; created_at_before?: string | undefined; created_at_before_or_equal?: string | undefined; limit?: number | undefined; offset?: number | undefined; user_id_gt?: string | undefined; user_id_gte?: string | undefined; user_id_lt?: string | undefined; user_id_lte?: string | undefined; } | { sort?: SortParamRequest[] | undefined; limit?: number | undefined; offset?: number | undefined; type?: string | undefined; members?: ChannelMemberRequest[] | undefined; id?: string | undefined; created_at_after?: Date | undefined; created_at_after_or_equal?: Date | undefined; created_at_before?: Date | undefined; created_at_before_or_equal?: Date | undefined; user_id_gt?: string | undefined; user_id_gte?: string | undefined; user_id_lt?: string | undefined; user_id_lte?: string | undefined; } |
stream-chat · ThreadUserReadState | { lastReadAt: Date; unreadMessageCount: number; user: UserResponse; lastReadMessageId?: string | undefined; firstUnreadMessageId?: string | undefined; } | { lastReadAt: TimestampNS; unreadMessageCount: number; user: UserResponse; lastReadMessageId?: string | undefined; firstUnreadMessageId?: string | undefined; } |
stream-chat · VideoRuleParameters | { threshold: number; time_window: string; harm_labels: string[]; } | interface |
stream-chat · ChannelUpdateOptions | { hide_history?: boolean | undefined; hide_history_before?: string | Date | undefined; skip_push?: boolean | undefined; } | { skip_push?: boolean | undefined; accept_invite?: boolean | undefined; cooldown?: number | undefined; hide_history?: boolean | undefined; hide_history_before?: Date | undefined; reject_invite?: boolean | undefined; add_filter_tags?: string[] | undefined; add_members?: ChannelMemberRequest[] | undefined; invites?: ChannelMemberRequest[] | undefined; remove_filter_tags?: string[] | undefined; remove_members?: string[] | undefined; data?: ChannelInputRequest | undefined; } |
stream-chat · DBUpsertChannelsType | { channels: ChannelAPIResponse[]; execute?: boolean | undefined; isLatestMessagesSet?: boolean | undefined; } | { channels: ChannelStateResponseFields[]; execute?: boolean | undefined; isLatestMessagesSet?: boolean | undefined; } |
stream-chat · DeleteMessageOptions | { deleteForMe?: boolean | undefined; hardDelete?: boolean | undefined; } | { hard?: boolean | undefined; delete_for_me?: boolean | undefined; } |
stream-chat · FilterConfigResponse | { llm_labels: string[]; ai_text_labels?: string[] | undefined; } | interface |
stream-chat · GetUserGroupResponse | APIResponse & { user_group: UserGroupResponse; } | interface |
stream-chat · LocalAudioAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "audio"; } & { localMetadata: LocalAttachmentUploadMetadata & CustomLocalMetadata & BaseLocalAttachmentMetadata; } |
stream-chat · LocalImageAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "image"; } & { localMetadata: LocalAttachmentUploadMetadata & { previewUri?: string | undefined; } & CustomLocalMetadata & BaseLocalAttachmentMetadata; } |
stream-chat · LocalVideoAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "video"; } & { localMetadata: LocalAttachmentUploadMetadata & CustomLocalMetadata & BaseLocalAttachmentMetadata; } |
stream-chat · MessageComposerState | { id: string; draftId: string | null; pollId: string | null; quotedMessage: LocalMessageBase | null; showReplyInChannel: boolean; editedMessage: LocalMessage | null; } | { id: string; draftId: string | null; pollId: string | null; quotedMessage: LocalMessage | null; showReplyInChannel: boolean; editedMessage: LocalMessage | null; } |
stream-chat · NotificationSeverity | "error" | "info" | (string & {}) | "warning" | "success" | "error" | (string & {}) | "warning" | "info" | "success" |
stream-chat · PollComposerSnapshot | { data: { id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; user_id?: string | undefined; voting_visibility?: VotingVisibility | undefined; }; errors: Partial<Omit<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", string>,… | { data: { id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; voting_visibility?: VotingVisibility | undefined; }; errors: Partial<Omit<Record<keyof CreatePollRequest, PollComposerValidationError>, "options"> & { options?: Record<string, PollComposerValidationError> | undefined; }>; } |
stream-chat · RuleBuilderCondition | { type: string; confidence?: number | undefined; text_rule_params?: TextRuleParameters | undefined; image_rule_params?: ImageRuleParameters | undefined; video_rule_params?: VideoRuleParameters | undefined; user_rule_params?: UserRuleParameters | undefined; content_count_rule_params?: ContentCountRuleParameters | undefined; text_content_params?: TextContentParameters | undefined; image_content_params?: ImageContentParameters | undefined; video_content_params?: VideoContentParameters | undefined; user_created_within_params?: UserCreatedWithinParameters | undefined; user_custom_property_params?: … | interface |
stream-chat · SubmitActionResponse | APIResponse & { item?: ReviewQueueItem | undefined; } | interface |
stream-chat · TextComposerSnapshot | { mentionedUsers: UserResponse[]; mentions?: MentionEntity[] | undefined; selection: TextSelection; text: string; command?: CommandResponse | null | undefined; suggestions?: Suggestions<Suggestion> | undefined; } | { mentionedUsers: UserResponse[]; mentions?: MentionEntity[] | undefined; selection: TextSelection; text: string; command?: Command | null | undefined; suggestions?: Suggestions<Suggestion> | undefined; } |
stream-chat · UpsertConfigResponse | { config: ModerationConfigResponse; } | interface |
stream-chat · VelocityFilterConfig | { cascading_actions: boolean; enabled: boolean; first_message_only: boolean; rules: VelocityFilterConfigRule[]; async?: boolean | undefined; } | interface |
stream-chat · AutomodToxicityConfig | { enabled: boolean; rules: AutomodRule[]; async?: boolean | undefined; } | interface |
stream-chat · ChannelConfigWithInfo | ChannelConfigFields & CreatedAtUpdatedAt & { commands?: CommandResponse[] | undefined; scheduled_messages_max_lead_time_seconds?: number | undefined; scheduled_messages_max_per_channel?: number | undefined; scheduled_messages_max_per_user?: number | undefined; scheduled_messages_min_lead_time_seconds?: number | undefined; } | interface |
stream-chat · ChannelManagerOptions | { abortInFlightQuery?: boolean | undefined; allowNotLoadedChannelPromotionForEvent?: { 'channel.visible': boolean; 'message.new': boolean; 'notification.added_to_channel': boolean; 'notification.message_new': boolean; } | undefined; lockChannelOrder?: boolean | undefined; } | { client: StreamChat; paginators?: ChannelPaginator[] | undefined; eventHandlers?: Partial<Record<SupportedEventType, LabeledEventHandler<ChannelManagerEventHandlerContext>[]>> | undefined; ownershipResolver?: string[] | PaginatorOwnershipResolver | undefined; } |
stream-chat · ChannelMemberResponse | CustomMemberData & { archived_at?: string | null | undefined; ban_expires?: string | undefined; banned?: boolean | undefined; channel_role?: Role | undefined; created_at?: string | undefined; invite_accepted_at?: string | undefined; invite_rejected_at?: string | undefined; invited?: boolean | undefined; is_moderator?: boolean | undefined; notifications_muted?: boolean | undefined; pinned_at?: string | null | undefined; role?: string | undefined; shadow_banned?: boolean | undefined; status?: InviteStatus | undefined; updated_at?: string | undefined; user?: UserResponse | undefined; user_id?: st… | interface |
stream-chat · LocationComposerState | { location: StaticLocationPayload | LiveLocationPreview | null; } | { location: StaticLocationPreview | LiveLocationPreview | null; } |
stream-chat · MessageComposerConfig | { drafts: DraftsConfiguration; commands: CommandsConfig; attachments: AttachmentManagerConfig; linkPreviews: LinkPreviewsManagerConfig; location: LocationComposerConfig; text: TextComposerConfig; } | { drafts: DraftsConfiguration; commands: CommandsConfig; attachments: AttachmentManagerConfig; linkPreviews: LinkPreviewsManagerConfig; location: LocationComposerConfig; polls: PollComposerConfig; retainCompositionOnSubmit: (composer: MessageComposer) => boolean; text: TextComposerConfig; } |
stream-chat · ModerationFlagOptions | { custom?: Record<string, unknown> | undefined; moderation_payload?: ModerationPayload | undefined; user_id?: string | undefined; } | { custom?: Record<string, any> | undefined; entity_creator_id?: string | undefined; moderation_payload?: ModerationPayload | undefined; } |
stream-chat · PaginationQueryParams | { direction: PaginationDirection; } | { claimsActiveInterval?: boolean | undefined; direction?: PaginationDirection | undefined; keepPreviousItems?: boolean | undefined; queryShape?: Q | undefined; reset?: StateResetPolicy | undefined; requestOptions?: Record<string, unknown> | undefined; retryCount?: number | undefined; silent?: boolean | undefined; updateState?: boolean | undefined; } |
stream-chat · QueryLogicalOperators | { $and?: ArrayOneOrMore<QueryFilters<Operators>> | undefined; $nor?: ArrayOneOrMore<QueryFilters<Operators>> | undefined; $or?: ArrayTwoOrMore<QueryFilters<Operators>> | undefined; } | { $and?: QueryFilters<Operators>[] | undefined; $nor?: QueryFilters<Operators>[] | undefined; $or?: QueryFilters<Operators>[] | undefined; } |
stream-chat · ReactionGroupResponse | { count: number; sum_scores: number; first_reaction_at?: string | undefined; last_reaction_at?: string | undefined; latest_reactions_by?: ReactionGroupUserResponse[] | undefined; } | interface |
stream-chat · StaticLocationPreview | { created_by_device_id: string; latitude: number; longitude: number; message_id: string; } | SharedLocation & { message_id?: string | undefined; } |
stream-chat · TextContentParameters | { harm_labels?: string[] | undefined; llm_harm_labels?: Record<string, string> | undefined; contains_url?: boolean | undefined; severity?: string | undefined; blocklist_match?: string[] | undefined; } | interface |
stream-chat · UpdateChannelResponse | APIResponse & Omit<CreateChannelOptions, "client_id" | "connection_id"> & { created_at: string; updated_at: string; } | interface |
stream-chat · notifyCommandDisabled | (composer: MessageComposer, command: CommandResponse): true | undefined | (composer: MessageComposer, command: Command): true | undefined |
stream-chat · DeleteChannelsResponse | { result: Record<string, string>; } & Partial<TaskResponse> | interface |
stream-chat · ImageContentParameters | { harm_labels: string[]; } | interface |
stream-chat · LocationComposerConfig | { enabled: boolean; getDeviceId: () => string; } | { enabled: boolean; getDeviceId: () => string; minShareDurationMs: number; } |
stream-chat · PendingMessageResponse | { message: MessageResponse; pending_message_metadata?: Record<string, string> | undefined; } | interface |
stream-chat · PollAnswersQueryParams | { filter?: QueryVotesFilters | undefined; options?: Pager | undefined; sort?: VoteSort | undefined; } | { filter?: ({ created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $gt: string | Date; $gte: string | Date; $lt: string | Date; $lte: string | Date; }, "$eq" | "$gt" | "$gte" | "$lt" | "$lte"> | null | undefined; id?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; is_answer?: boolean | RequireOnlyOne<{ $eq: boolean | null; }, "$eq"> | null | undefined; option_id?: string | RequireOnlyOne<{ $eq: string | null; $exists: boolean; $in: string[]; }, "$eq" | "$exists" | "$in"> | null | undefined; poll_id?: string | RequireOnlyOn… |
stream-chat · QueryRemindersResponse | { reminders: ReminderResponse[]; prev?: string | undefined; next?: string | undefined; } | interface |
stream-chat · SendMessageAPIResponse | APIResponse & { message: MessageResponse; pending_message_metadata?: Record<string, string> | null | undefined; } | SendMessageResponse & { metadata: RequestMetadata; } |
stream-chat · SharedLocationResponse | { channel_cid: string; created_at: string; created_by_device_id: string; end_at?: string | undefined; latitude: number; longitude: number; message_id: string; updated_at: string; user_id: string; } | interface |
stream-chat · VideoContentParameters | { harm_labels: string[]; } | interface |
stream-chat · mapPollStateToResponse | (poll: Poll, state?: PollState | undefined): PollResponse | (poll: Poll, state?: PollState | undefined): PollResponseData |
stream-chat · AnnounceDeliveryOptions | { user?: UserResponse | undefined; user_id?: string | undefined; } | {} |
stream-chat · AttachmentManagerConfig | { fileUploadFilter: FileUploadFilter; maxNumberOfFilesPerMessage: number; acceptedFiles: string[]; doUploadRequest?: UploadRequestFn | undefined; trackUploadProgress: boolean; } | { enabled: boolean; fileUploadFilter: FileUploadFilter; maxNumberOfFilesPerMessage: number; acceptedFiles: string[]; doUploadRequest?: UploadRequestFn | undefined; customCdn: boolean; pendingUploadsEnabled: boolean; trackUploadProgress: boolean; } |
stream-chat · CreateUserGroupResponse | APIResponse & { user_group: UserGroupResponse; } | interface |
stream-chat · DBUpsertAppSettingsType | { appSettings: AppSettingsAPIResponse; userId: string; execute?: boolean | undefined; } | { appSettings: GetApplicationResponse; userId: string; execute?: boolean | undefined; } |
stream-chat · LocalAttachmentMetadata | CustomLocalMetadata & BaseLocalAttachmentMetadata & LocalAttachmentUploadMetadata & { previewUri?: string | undefined; } | CustomLocalMetadata & BaseLocalAttachmentMetadata & (Partial<Omit<LocalImageAttachmentUploadMetadata, "file" | "uploadState">> & (LocalAttachmentFileFields | LocalAttachmentNoFileFields)) |
stream-chat · MODERATION_ENTITY_TYPES | { user: string; message: string; userprofile: string; } | { user: string; message: string; } |
stream-chat · PollComposerFieldErrors | { id?: string | undefined; user_id?: string | undefined; name?: string | undefined; description?: string | undefined; allow_answers?: string | undefined; allow_user_suggested_options?: string | undefined; enforce_unique_vote?: string | undefined; is_closed?: string | undefined; max_votes_allowed?: string | undefined; voting_visibility?: string | undefined; options?: Record<string, string> | undefined; } | { custom?: PollComposerValidationError | undefined; team?: PollComposerValidationError | undefined; id?: PollComposerValidationError | undefined; name?: PollComposerValidationError | undefined; max_votes_allowed?: PollComposerValidationError | undefined; allow_answers?: PollComposerValidationError | undefined; allow_user_suggested_options?: PollComposerValidationError | undefined; description?: PollComposerValidationError | undefined; enforce_unique_vote?: PollComposerValidationError | undefined; is_closed?: PollComposerValidationError | undefined; voting_visibility?: PollComposerValidationErr… |
stream-chat · PushPreferencesResponse | { call_level?: CallLevelPushPreference | undefined; chat_level?: ChatLevelPushPreference | undefined; chat_preferences?: ChatPreferences | undefined; disabled_until?: string | undefined; } | interface |
stream-chat · SearchControllerOptions | { config?: Partial<SearchControllerConfig> | undefined; sources?: SearchSource<any>[] | undefined; } | { client?: StreamChat | undefined; config?: Partial<SearchControllerConfig> | undefined; sources?: SearchSource<any>[] | undefined; } |
stream-chat · SearchUserGroupsOptions | { query: string; limit?: number | undefined; id_gt?: string | undefined; name_gt?: string | undefined; team_id?: string | undefined; } | { query: string; limit?: number | undefined; name_gt?: string | undefined; id_gt?: string | undefined; team_id?: string | undefined; } |
stream-chat · UpdateUserGroupResponse | APIResponse & { user_group: UserGroupResponse; } | interface |
stream-chat · UserSearchSourceOptions | SearchSourceOptions & { filters?: UserFilters | undefined; sort?: UserSort | undefined; searchOptions?: Omit<UserOptions, "limit" | "offset"> | undefined; } | SearchSourceOptions & { filters?: Filters<{ banned: { type: boolean; operators: "$eq" | "$ne"; }; bypass_moderation: { type: boolean; operators: "$eq" | "$ne"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomUserData; operators: "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; email: { type: string; operators: "$eq" | "$in"; }; id: { type: string; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$nin" | "$ne" | "$autocomplete"; }; language: { type: string… |
stream-chat · extractPollEnrichedData | (pollResponse: PollResponse): Omit<PollEnrichData, "own_votes" | "latest_answers"> | (pollResponse: PollResponseData): Pick<PollResponseData, "answers_count" | "vote_count" | "latest_votes_by_option" | "vote_counts_by_option"> |
stream-chat · DBUpsertCidsForQueryType | { cids: string[]; filters?: ChannelFilters | undefined; options?: ChannelOptions | undefined; execute?: boolean | undefined; sort?: ChannelSort | undefined; } | { cids: string[]; filters?: ({ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; $autocomplete: string | number | boolean | Date; $q: string | number | boolean | Date; }, "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$autocomplete" … |
stream-chat · LocationComposerSnapshot | { location: StaticLocationPayload | LiveLocationPreview | null; } | { location: StaticLocationPreview | LiveLocationPreview | null; } |
stream-chat · PollStateChangeValidator | (params: { data: { id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; user_id?: string | undefined; voting_visibility?: VotingVisibility | undefined; }; value: any; currentError?: string | Record<string, string> | undefined; }) => Partial<Omit<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" … | (params: { data: { id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; voting_visibility?: VotingVisibility | undefined; }; value: any; currentError?: PollComposerValidationError | Record<string, PollComposerValidationError> | undefined; }) => Partial<Omit<Record<"id" | "name" | "options" | "max_votes_allowed" | "allow_answers" | "allow_user_suggested_options" | "des… |
stream-chat · SearchUserGroupsResponse | APIResponse & { user_groups: UserGroupResponse[]; } | interface |
stream-chat · UpdateMessageAPIResponse | APIResponse & { message: MessageResponse; } | UpdateMessageResponse & { metadata: RequestMetadata; } |
stream-chat · VelocityFilterConfigRule | { action: "flag" | "ban" | "remove" | "shadow"; ban_duration?: number | undefined; cascading_action?: "flag" | "ban" | "remove" | "shadow" | undefined; cascading_threshold?: number | undefined; check_message_context?: boolean | undefined; fast_spam_threshold?: number | undefined; fast_spam_ttl?: number | undefined; ip_ban?: boolean | undefined; shadow_ban?: boolean | undefined; slow_spam_ban_duration?: number | undefined; slow_spam_threshold?: number | undefined; slow_spam_ttl?: number | undefined; } | interface |
stream-chat · VoiceRecordingAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "voiceRecording"; custom: CustomAttachmentData & { duration?: number | undefined; waveform_data?: number[] | undefined; }; } |
stream-chat · DBGetChannelsForQueryType | { userId: string; filters?: ChannelFilters | undefined; options?: ChannelOptions | undefined; sort?: ChannelSort | undefined; } | { userId: string; options?: QueryChannelsRequest | undefined; } |
stream-chat · PollStateValidationOutput | { id?: string | undefined; user_id?: string | undefined; name?: string | undefined; description?: string | undefined; allow_answers?: string | undefined; allow_user_suggested_options?: string | undefined; enforce_unique_vote?: string | undefined; is_closed?: string | undefined; max_votes_allowed?: string | undefined; voting_visibility?: string | undefined; options?: Record<string, string> | undefined; } | { id?: PollComposerValidationError | undefined; name?: PollComposerValidationError | undefined; max_votes_allowed?: PollComposerValidationError | undefined; allow_answers?: PollComposerValidationError | undefined; allow_user_suggested_options?: PollComposerValidationError | undefined; description?: PollComposerValidationError | undefined; enforce_unique_vote?: PollComposerValidationError | undefined; is_closed?: PollComposerValidationError | undefined; voting_visibility?: PollComposerValidationError | undefined; options?: Record<string, PollComposerValidationError> | undefined; } |
stream-chat · ReactionGroupUserResponse | { created_at: string; user_id: string; user?: UserResponse | undefined; } | interface |
stream-chat · RuleBuilderConditionGroup | { logic: "AND" | "OR"; conditions: RuleBuilderCondition[]; } | interface |
stream-chat · TextComposerStateSnapshot | { mentionedUsers: UserResponse[]; mentions?: MentionEntity[] | undefined; selection: TextSelection; text: string; command?: CommandResponse | null | undefined; suggestions?: Suggestions<Suggestion> | undefined; } | { mentionedUsers: UserResponse[]; mentions?: MentionEntity[] | undefined; selection: TextSelection; text: string; command?: Command | null | undefined; suggestions?: Suggestions<Suggestion> | undefined; } |
stream-chat · pollStateChangeValidators | Partial<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", PollStateChangeValidator>> | Partial<Record<"id" | "name" | "options" | "max_votes_allowed" | "allow_answers" | "allow_user_suggested_options" | "description" | "enforce_unique_vote" | "is_closed" | "voting_visibility", PollStateChangeValidator>> |
stream-chat · AutomodSemanticFiltersRule | { action: ModerationActionType; name: string; threshold: number; } | interface |
stream-chat · ChannelSearchSourceOptions | SearchSourceOptions & { filters?: ChannelFilters | undefined; sort?: ChannelSort | undefined; searchOptions?: Omit<ChannelOptions, "limit" | "offset"> | undefined; } | SearchSourceOptions & { filters?: ({ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; $autocomplete: string | number | boolean | Date; $q: string | number | boolean | Date; }, "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$autocomp… |
stream-chat · ContentCountRuleParameters | { threshold: number; time_window: string; } | interface |
stream-chat · DEFAULT_PAGINATION_OPTIONS | Required<PaginatorOptions> | BasePaginatorConfig<any, any> |
stream-chat · MessageSearchSourceOptions | SearchSourceOptions & { messageSearchChannelFilters?: ChannelFilters | undefined; messageSearchFilters?: MessageFilters | undefined; messageSearchSort?: SearchMessageSort | undefined; channelQueryFilters?: ChannelFilters | undefined; channelQuerySort?: ChannelSort | undefined; channelQueryOptions?: Omit<ChannelOptions, "limit" | "offset"> | undefined; } | SearchSourceOptions & { messageSearchChannelFilters?: ({ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; $autocomplete: string | number | boolean | Date; $q: string | number | boolean | Date; }, "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" |… |
stream-chat · PaginationQueryReturnValue | { items: T[]; } & { next?: string | undefined; prev?: string | undefined; } | { items: T[]; } & { headward?: string | null | undefined; tailward?: string | null | undefined; } |
stream-chat · PollOptionVotesQueryParams | { filter: { option_id: string; } & { id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string> | undefined; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string> | undefined; $gte?: PrimitiveFilter<string> | undefined; $in?: PrimitiveFilter<string>[] | undefined; $lt?: PrimitiveFilter<string> | undefined; $lte?: PrimitiveFilter<string> | undefined; }, "$eq" | "$in">, "$eq" | "$in"> | PrimitiveFilter<string> | undefined; option_id?: RequireOnlyOne<Pick<{ $eq?: PrimitiveFilter<string | undefined>; $exists?: boolean | undefined; $gt?: PrimitiveFilter<string | undefined>; $gte?: PrimitiveFil… | { filter: { option_id: string; } & { created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $gt: string | Date; $gte: string | Date; $lt: string | Date; $lte: string | Date; }, "$eq" | "$gt" | "$gte" | "$lt" | "$lte"> | null | undefined; id?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; is_answer?: boolean | RequireOnlyOne<{ $eq: boolean | null; }, "$eq"> | null | undefined; option_id?: string | RequireOnlyOne<{ $eq: string | null; $exists: boolean; $in: string[]; }, "$eq" | "$exists" | "$in"> | null | undefined; poll_id?:… |
stream-chat · SharedLiveLocationResponse | { channel_cid: string; created_at: string; created_by_device_id: string; end_at: string; latitude: number; longitude: number; message_id: string; updated_at: string; user_id: string; } | Omit<SharedLocationResponseData, "end_at"> & Required<Pick<SharedLocationResponseData, "end_at">> |
stream-chat · AddUserGroupMembersResponse | APIResponse & { user_group: UserGroupResponse; } | interface |
stream-chat · MentionsSearchSourceOptions | SearchSourceOptions & { userFilters?: UserFilters | undefined; userSort?: UserSort | undefined; memberFilters?: MemberFilters | undefined; memberSort?: MemberSort | undefined; searchOptions?: Omit<UserOptions, "limit" | "offset"> | undefined; mentionAllAppUsers?: boolean | undefined; suggestionFactoryMappers?: MentionSuggestionFactoryMapperOverrides | undefined; textComposerText?: string | undefined; trigger?: string | undefined; transliterate?: ((text: string) => string) | undefined; } | SearchSourceOptions & { userFilters?: Filters<{ banned: { type: boolean; operators: "$eq" | "$ne"; }; bypass_moderation: { type: boolean; operators: "$eq" | "$ne"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomUserData; operators: "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; email: { type: string; operators: "$eq" | "$in"; }; id: { type: string; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$nin" | "$ne" | "$autocomplete"; }; language: { type: st… |
stream-chat · UserCreatedWithinParameters | { max_age: string; } | interface |
stream-chat · AutomodSemanticFiltersConfig | { enabled: boolean; rules: AutomodSemanticFiltersRule[]; async?: boolean | undefined; } | interface |
stream-chat · CommandSendValidationContext | { command: CommandResponse; composer: MessageComposer; commandArgsText: string; mentionedUsersInText: UserResponse[]; rawText: string; } | { command: Command; composer: MessageComposer; commandArgsText: string; mentionedUsersInText: UserResponse[]; rawText: string; } |
stream-chat · MessageCompositionMiddleware | Middleware<MessageComposerMiddlewareState, "compose"> & { allowsPendingUploads?: boolean | undefined; } | { id: string; handlers: MiddlewareHandlers<MessageComposerMiddlewareState, "compose">; } |
stream-chat · ScheduledLiveLocationSharing | SharedLiveLocationResponse & { stopSharingTimeout: number | null; } | Omit<SharedLocationResponseData, "end_at"> & Required<Pick<SharedLocationResponseData, "end_at">> & { stopSharingTimeout: number | null; } |
stream-chat · THREAD_MANAGER_INITIAL_STATE | { active: boolean; wasActivatedAtLeastOnce: boolean; isThreadOrderStale: boolean; threads: never[]; unreadThreadCount: number; unseenThreadIds: never[]; lastConnectionDropAt: null; pagination: { isLoading: boolean; isLoadingNext: boolean; nextCursor: null; }; ready: boolean; } | ThreadManagerState |
stream-chat · UserCustomPropertyParameters | { property_key: string; operator: string; expected_value: string; } | interface |
stream-chat · LocalVoiceRecordingAttachment | CustomAttachmentData & { actions?: Action[] | undefined; asset_url?: string | undefined; author_icon?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; color?: string | undefined; duration?: number | undefined; fallback?: string | undefined; fields?: Field[] | undefined; file_size?: string | number | undefined; footer?: string | undefined; footer_icon?: string | undefined; giphy?: GiphyData | undefined; image_url?: string | undefined; latitude?: number | undefined; longitude?: number | undefined; mime_type?: string | undefined; og_scrape_url?: string | un… | Attachment & { type: "voiceRecording"; custom: CustomAttachmentData & { duration?: number | undefined; waveform_data?: number[] | undefined; }; } & { localMetadata: LocalAttachmentUploadMetadata & CustomLocalMetadata & BaseLocalAttachmentMetadata; } |
stream-chat · PollCompositionStateProcessor | (params: { data: { id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; user_id?: string | undefined; voting_visibility?: VotingVisibility | undefined; }; value: any; }) => Partial<{ id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: … | (params: { data: { id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; voting_visibility?: VotingVisibility | undefined; }; value: any; }) => Partial<{ id: string; max_votes_allowed: string; name: string; options: PollComposerOption[]; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_un… |
stream-chat · UpsertPushPreferencesResponse | APIResponse & { user_channel_preferences: Record<string, Record<string, ChannelPushPreference>>; user_preferences: Record<string, PushPreferencesResponse>; } | interface |
stream-chat · DBDeleteMessagesForChannelType | { cid: string; truncated_at?: string | undefined; execute?: boolean | undefined; } | { cid: string; truncated_at?: TimestampNS | undefined; execute?: boolean | undefined; } |
stream-chat · MessageComposerMiddlewareState | { message: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; restricted_visibility?: string[] | undefined; show_in_channel?: boolean | undefined; silent?: boolean | undefined; text?: string | undefined; type?: MessageLabel | undefined; user?: UserResponse | null | undefined; user_id?: string | undefine… | { message: MessageRequest; localMessage: LocalMessage; sendOptions: SendMessageOptions; } |
stream-chat · ParsedPredefinedFilterResponse | { name: string; filter: F; sort?: PredefinedFilterSortParam[] | undefined; } | interface |
stream-chat · PinnedMessagePaginationOptions | { id_around?: string | undefined; id_gt?: string | undefined; id_gte?: string | undefined; id_lt?: string | undefined; id_lte?: string | undefined; limit?: number | undefined; offset?: number | undefined; pinned_at_after?: string | Date | undefined; pinned_at_after_or_equal?: string | Date | undefined; pinned_at_around?: string | Date | undefined; pinned_at_before?: string | Date | undefined; pinned_at_before_or_equal?: string | Date | undefined; } | { limit?: number | undefined; offset?: number | undefined; id_gte?: string | undefined; id_gt?: string | undefined; id_lte?: string | undefined; id_lt?: string | undefined; pinned_at_after_or_equal?: Date | undefined; pinned_at_after?: Date | undefined; pinned_at_before_or_equal?: Date | undefined; pinned_at_before?: Date | undefined; id_around?: string | undefined; pinned_at_around?: Date | undefined; member_custom_include?: string[] | undefined; } |
stream-chat · ReminderResponseBaseOrResponse | ReminderResponseBase & { user?: UserResponse | undefined; message?: MessageResponse | undefined; } | ReminderResponseData |
stream-chat · RemoveUserGroupMembersResponse | APIResponse & { user_group: UserGroupResponse; } | interface |
stream-chat · pollCompositionStateProcessors | Partial<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", PollCompositionStateProcessor>> | Partial<Record<"id" | "name" | "options" | "max_votes_allowed" | "allow_answers" | "allow_user_suggested_options" | "description" | "enforce_unique_vote" | "is_closed" | "voting_visibility", PollCompositionStateProcessor>> |
stream-chat · CommandSuggestionDisabledReason | "quoted_message" | "editing" | "editing" | "quoted_message" |
stream-chat · localMessageToNewMessagePayload | (localMessage: LocalMessage): Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: string | undefined; quoted_message_id?: string | undefined; restricted_visibility?: string[] | undefined; show_in_channel?: boolean | undefined; silent?: boolean | undefined; text?: string | undefined; type?: MessageLabel | undefined; user?: UserResponse | null | undefined; user_id?… | (localMessage: LocalMessage): MessageRequest |
stream-chat · ChannelMemberSearchSourceOptions | SearchSourceOptions & { filters?: MemberFilters | undefined; sort?: MemberSort | undefined; searchOptions?: Omit<QueryMembersOptions, "limit" | "offset"> | undefined; } | SearchSourceOptions & { filters?: Filters<{ banned: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type: string; operators: "$eq"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomMemberData; operators: "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" | "$autocomplete" | "$q"; }; id: { type: string; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; invite: { type: string; operators: "$eq"; }; is_moderato… |
stream-chat · OwnMessageReceiptsTrackerOptions | { locateMessage: OwnMessageReceiptsTrackerMessageLocator; } | { channel: Channel; locateMessage?: OwnMessageReceiptsTrackerMessageLocator | undefined; } |
stream-chat · QueryChannelsResponseWithChannels | Omit<QueryChannelsAPIResponse, "channels"> & { channels: Channel[]; } | Omit<QueryChannelsResponse, "channels"> & { channels: Channel[]; } |
stream-chat · AutomodPlatformCircumventionConfig | { enabled: boolean; rules: AutomodRule[]; async?: boolean | undefined; } | interface |
stream-chat · PollCompositionStateProcessorOutput | { id?: string | undefined; max_votes_allowed?: string | undefined; name?: string | undefined; options?: PollComposerOption[] | undefined; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; user_id?: string | undefined; voting_visibility?: VotingVisibility | undefined; } | { id?: string | undefined; max_votes_allowed?: string | undefined; name?: string | undefined; options?: PollComposerOption[] | undefined; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; voting_visibility?: VotingVisibility | undefined; } |
stream-chat · TextComposerCommandActivationEffect | { command: CommandResponse; stateToRestore?: Partial<TextComposerStateSnapshot> | undefined; type: "command.activate"; } | { command: Command; stateToRestore?: Partial<TextComposerStateSnapshot> | undefined; type: "command.activate"; } |
stream-chat · defaultPollFieldBlurEventValidators | Partial<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", PollStateChangeValidator>> | Partial<Record<"id" | "name" | "options" | "max_votes_allowed" | "allow_answers" | "allow_user_suggested_options" | "description" | "enforce_unique_vote" | "is_closed" | "voting_visibility", PollStateChangeValidator>> |
stream-chat · defaultPollFieldChangeEventValidators | Partial<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", PollStateChangeValidator>> | Partial<Record<"id" | "name" | "options" | "max_votes_allowed" | "allow_answers" | "allow_user_suggested_options" | "description" | "enforce_unique_vote" | "is_closed" | "voting_visibility", PollStateChangeValidator>> |
stream-chat · PollComposerStateChangeMiddlewareValue | { nextState: PollComposerState; previousState: PollComposerState; targetFields: Partial<{ id: string; max_votes_allowed: string; name: string; options: PollComposerOptionUpdate; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; user_id?: string | undefined; voting_visibility?: VotingVisibility | undefined; }>; injectedFieldErrors?: Partial<Omit<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "e… | { nextState: PollComposerState; previousState: PollComposerState; targetFields: Partial<{ id: string; max_votes_allowed: string; name: string; options: PollComposerOptionUpdate; allow_answers?: boolean | undefined; allow_user_suggested_options?: boolean | undefined; description?: string | undefined; enforce_unique_vote?: boolean | undefined; is_closed?: boolean | undefined; voting_visibility?: VotingVisibility | undefined; }>; injectedFieldErrors?: Partial<Omit<Record<keyof CreatePollRequest, PollComposerValidationError>, "options"> & { options?: Record<string, PollComposerValidationError> | u… |
stream-chat · getAllowedMentionTypesFromCapabilities | (ownCapabilities?: string[] | undefined): Record<"user" | "channel" | "role" | "here" | "user_group", boolean> | (ownCapabilities?: string[] | undefined): Record<"channel" | "user" | "user_group" | "role" | "here", boolean> |
stream-chat · MentionSuggestionFactoryMapperOverrides | { user?: MentionSuggestionFactoryMapper<"user"> | undefined; channel?: MentionSuggestionFactoryMapper<"channel"> | undefined; role?: MentionSuggestionFactoryMapper<"role"> | undefined; here?: MentionSuggestionFactoryMapper<"here"> | undefined; user_group?: MentionSuggestionFactoryMapper<"user_group"> | undefined; } | { channel?: MentionSuggestionFactoryMapper<"channel"> | undefined; user?: MentionSuggestionFactoryMapper<"user"> | undefined; user_group?: MentionSuggestionFactoryMapper<"user_group"> | undefined; role?: MentionSuggestionFactoryMapper<"role"> | undefined; here?: MentionSuggestionFactoryMapper<"here"> | undefined; } |
stream-chat · MessageSearchSourceFilterBuilderOptions | { messageSearchChannel?: FilterBuilderOptions<ChannelFilters, MergeContext<{ searchQuery?: string | undefined; }, TContexts["messageSearchChannelContext"]>> | undefined; messageSearch?: FilterBuilderOptions<MessageFilters, MergeContext<{ searchQuery?: string | undefined; }, TContexts["messageSearchContext"]>> | undefined; channelQuery?: FilterBuilderOptions<ChannelFilters, MergeContext<{ cids?: string[] | undefined; }, TContexts["channelQueryContext"]>> | undefined; } | { messageSearchChannel?: FilterBuilderOptions<{ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string | number | boolean | Date; $autocomplete: string | number | boolean | Date; $q: string | number | boolean | Date; }, "$contains" | "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte" |… |
stream-chat · OwnMessageReceiptsTrackerMessageLocator | (timestampMs: number) => MsgRef | null | (timestamp: TimestampNS) => MsgRef | null |
stream-chat · MessageDraftComposerMiddlewareValueState | { draft: DraftMessagePayload; } | { draft: MessageRequest; } |
stream-chat · PollComposerStateMiddlewareFactoryOptions | { processors?: { handleFieldChange?: Partial<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", PollCompositionStateProcessor>> | undefined; handleFieldBlur?: Partial<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", PollCompositionStateProcessor>> | undefined; } | undefined; validators?: { handleFieldChange?:… | { processors?: { handleFieldChange?: Partial<Record<"id" | "name" | "options" | "max_votes_allowed" | "allow_answers" | "allow_user_suggested_options" | "description" | "enforce_unique_vote" | "is_closed" | "voting_visibility", PollCompositionStateProcessor>> | undefined; handleFieldBlur?: Partial<Record<"id" | "name" | "options" | "max_votes_allowed" | "allow_answers" | "allow_user_suggested_options" | "description" | "enforce_unique_vote" | "is_closed" | "voting_visibility", PollCompositionStateProcessor>> | undefined; } | undefined; validators?: { handleFieldChange?: Partial<Record<"id" | "… |
stream-chat · PollComposerCompositionMiddlewareValueState | { data: CreatePollData; errors: Partial<Omit<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", string>, "options"> & { options?: Record<string, string> | undefined; }>; } | { data: CreatePollRequest; errors: Partial<Omit<Record<keyof CreatePollRequest, PollComposerValidationError>, "options"> & { options?: Record<string, PollComposerValidationError> | undefined; }>; } |
stream-chat · TextComposerCommandActivationStateToRestore | { mentionedUsers?: UserResponse[] | undefined; mentions?: MentionEntity[] | undefined; selection?: TextSelection | undefined; text?: string | undefined; command?: CommandResponse | null | undefined; suggestions?: Suggestions<Suggestion> | undefined; } | { mentionedUsers?: UserResponse[] | undefined; mentions?: MentionEntity[] | undefined; selection?: TextSelection | undefined; text?: string | undefined; command?: Command | null | undefined; suggestions?: Suggestions<Suggestion> | undefined; } |
Anggota kelas atau antarmuka yang dihapus
| member | import | Sebelum |
|---|---|---|
Thread.loadPage | stream-chat | any |
Thread.deactivate | stream-chat | (): void |
Thread.loadNextPage | stream-chat | ({ limit }?: { limit?: number | undefined; } | undefined): Promise<void> |
Thread.loadPrevPage | stream-chat | ({ limit }?: { limit?: number | undefined; } | undefined): Promise<void> |
Thread.queryReplies | stream-chat | ({ limit, sort, ...otherOptions }?: QueryRepliesOptions | undefined): Promise<GetRepliesAPIResponse> |
Thread.subscribeNewReplies | stream-chat | any |
Thread.throttledMarkAsRead | stream-chat | any |
Thread.subscribeRepliesRead | stream-chat | any |
Thread.subscribeRepliesUnread | stream-chat | any |
Thread.subscribeThreadUpdated | stream-chat | any |
Thread.subscribeMessageDeleted | stream-chat | any |
Thread.subscribeMessageUpdated | stream-chat | any |
Thread.subscribeMarkThreadStale | stream-chat | any |
Channel.search | stream-chat | (query: string | MessageFilters, options?: (SearchOptions & { client_id?: string | undefined; connection_id?: string | undefined; message_filter_conditions?: MessageFilters | undefined; message_options?: MessageOptions | undefined; query?: string | undefined; }) | undefined): Promise<SearchAPIRespon… |
Channel._update | stream-chat | (payload: object): Promise<UpdateChannelAPIResponse> |
Channel.sendFile | stream-chat | (uri: any, name?: string | undefined, contentType?: string | undefined, user?: UserResponse | undefined, axiosRequestConfig?: any): Promise<SendFileAPIResponse> |
Channel.getConfig | stream-chat | (): ChannelConfigWithInfo | undefined |
Channel.sendImage | stream-chat | (uri: any, name?: string | undefined, contentType?: string | undefined, user?: UserResponse | undefined, axiosRequestConfig?: any): Promise<SendFileAPIResponse> |
Channel.shadowBan | stream-chat | (targetUserID: string, options: BanUserOptions): Promise<APIResponse> |
Channel.getReplies | stream-chat | (parent_id: string, options: PaginationOptions & { created_at_around?: string | Date | undefined; id_around?: string | undefined; } & { user?: UserResponse | undefined; user_id?: string | undefined; }, sort?: { created_at: AscDesc; }[] | undefined): Promise<GetRepliesAPIResponse> |
Channel._channelURL | stream-chat | (): string |
Channel._disconnect | stream-chat | (): void |
Channel.assignRoles | stream-chat | (roles: { channel_role: Role; user_id: string; }[], message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; … |
Channel.lastMessage | stream-chat | (): LocalMessage | undefined |
Channel._sendMessage | stream-chat | (rawMessage: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: … |
Channel.disconnected | stream-chat | boolean |
Channel.getReactions | stream-chat | (message_id: string, options: { limit?: number | undefined; offset?: number | undefined; }): Promise<GetReactionsAPIResponse> |
Channel._sendReaction | stream-chat | (messageID: string, reaction: Reaction, options?: SendReactionOptions | undefined): Promise<ReactionAPIResponse> |
Channel.addModerators | stream-chat | (members: string[], message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | unde… |
Channel._deleteReaction | stream-chat | (messageID: string, reactionType: string, user_id?: string | undefined): Promise<ReactionAPIResponse> |
Channel.removeShadowBan | stream-chat | (targetUserID: string): Promise<APIResponse> |
Channel.demoteModerators | stream-chat | (members: string[], message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | unde… |
Channel.markAsReadRequest | stream-chat | (data?: MarkReadOptions | undefined): Promise<EventAPIResponse | null> |
Channel.partialUpdateMember | stream-chat | (user_id: string, updates: PartialUpdateMember): Promise<PartialUpdateMemberAPIResponse> |
Moderation.check | stream-chat | (entityType: string, entityID: string, entityCreatorID: string, moderationPayload: { custom?: Record<string, any> | undefined; images?: string[] | undefined; texts?: string[] | undefined; videos?: string[] | undefined; }, configKey: string, options?: { force_sync?: boolean | undefined; } | undefined… |
Moderation.muteUser | stream-chat | (targetID: string, options?: ModerationMuteOptions | undefined): Promise<APIResponse & { mute?: MuteResponse | undefined; mutes?: Mute[] | undefined; own_user?: OwnUserResponse | undefined; non_existing_users?: string[] | undefined; }> |
Moderation.queryConfigs | stream-chat | (filterConditions: QueryModerationConfigsFilters, sort: QueryModerationConfigsSort, options?: Pager | undefined): Promise<QueryConfigsResponse> |
Moderation.addCustomFlags | stream-chat | (entityType: string, entityID: string, entityCreatorID: string, moderationPayload: { custom?: Record<string, any> | undefined; images?: string[] | undefined; texts?: string[] | undefined; videos?: string[] | undefined; }, flags: CustomCheckFlag[]): Promise<CustomCheckResponse> |
Moderation.checkUserProfile | stream-chat | (userId: string, profile: RequireAtLeastOne<{ image?: string | undefined; username?: string | undefined; }>): Promise<CheckResponse> |
Moderation.getModerationRule | stream-chat | (id: string): Promise<{ rule: ModerationRule; }> |
Moderation.deleteModerationRule | stream-chat | (id: string): Promise<APIResponse> |
Moderation.queryModerationRules | stream-chat | (filterConditions?: QueryModerationRulesFilters | undefined, sort?: QueryModerationRulesSort | undefined, options?: Pager | undefined): Promise<QueryModerationRulesResponse> |
Moderation.upsertModerationRule | stream-chat | (rule: ModerationRuleRequest): Promise<UpsertModerationRuleResponse> |
Moderation.addCustomMessageFlags | stream-chat | (messageID: string, flags: CustomCheckFlag[]): Promise<CustomCheckResponse> |
Moderation.getUserModerationReport | stream-chat | (userID: string, options?: GetUserModerationReportOptions | undefined): Promise<GetUserModerationReportResponse> |
StreamChat.get | stream-chat | <T>(url: string, params?: any, config?: Omit<AxiosRequestConfig, "params"> | undefined): Promise<T> |
StreamChat.put | stream-chat | <T>(url: string, data?: unknown): Promise<T> |
StreamChat.post | stream-chat | <T>(url: string, data?: unknown, config?: Omit<AxiosRequestConfig, "params"> | undefined): Promise<T> |
StreamChat.patch | stream-chat | <T>(url: string, data?: unknown): Promise<T> |
StreamChat._sayHi | stream-chat | (): void |
StreamChat.delete | stream-chat | <T>(url: string, params?: any): Promise<T> |
StreamChat.logger | stream-chat | (logLevel: LogLevel, message: string, extraData?: Record<string, unknown> | undefined): void |
StreamChat.secret | stream-chat | string | undefined |
StreamChat.banUser | stream-chat | (targetUserID: string, options?: BanUserOptions | undefined): Promise<APIResponse> |
StreamChat.configs | stream-chat | Configs |
StreamChat.getTask | stream-chat | (id: string): Promise<APIResponse & TaskStatus> |
StreamChat.options | stream-chat | any |
StreamChat.segment | stream-chat | (type: SegmentType, idOrData: string | SegmentData, data?: SegmentData | undefined): Segment |
StreamChat.campaign | stream-chat | (idOrData: string | CampaignData, data?: CampaignData | undefined): Campaign |
StreamChat.flagUser | stream-chat | (targetID: string, options?: { reason?: string | undefined; user_id?: string | undefined; } | undefined): Promise<FlagUserResponse> |
StreamChat.muteUser | stream-chat | (targetID: string, userID?: string | undefined, options?: MuteUserOptions | undefined): Promise<MuteUserResponse> |
StreamChat.parseSns | stream-chat | (notificationBody: string): Event |
StreamChat.parseSqs | stream-chat | (messageBody: string): Event |
StreamChat.sendFile | stream-chat | (url: string, uri: any, name?: string | undefined, contentType?: string | undefined, user?: UserResponse | undefined, axiosRequestConfig?: any): Promise<SendFileAPIResponse> |
StreamChat._getToken | stream-chat | (): string | null | undefined |
StreamChat.addDevice | stream-chat | (id: string, push_provider: PushProvider, userID?: string | undefined, push_provider_name?: string | undefined): Promise<APIResponse> |
StreamChat.closePoll | stream-chat | (id: string, userId?: string | undefined): Promise<APIResponse & UpdatePollAPIResponse> |
StreamChat.enrichURL | stream-chat | (url: string): Promise<APIResponse & OGAttachment> |
StreamChat.listRoles | stream-chat | (): Promise<ListRolesAPIResponse> |
StreamChat.shadowBan | stream-chat | (targetUserID: string, options?: BanUserOptions | undefined): Promise<APIResponse> |
StreamChat.translate | stream-chat | (text: string, destination_language: string, source_language: string): Promise<APIResponse & TranslateResponse> |
StreamChat._getImport | stream-chat | (id: string): Promise<APIResponse & GetImportResponse> |
StreamChat.createRole | stream-chat | (name: string): Promise<CreateRoleAPIResponse> |
StreamChat.deleteRole | stream-chat | (name: string): Promise<APIResponse> |
StreamChat.deleteUser | stream-chat | (userID: string, params?: { delete_conversation_channels?: boolean | undefined; hard_delete?: boolean | undefined; mark_messages_deleted?: boolean | undefined; } | undefined): Promise<APIResponse & { user: UserResponse; } & { task_id?: string | undefined; }> |
StreamChat.exportUser | stream-chat | (userID: string, options?: Record<string, string> | undefined): Promise<APIResponse & { messages: MessageResponse[]; reactions: ReactionResponse[]; user: UserResponse; }> |
StreamChat.getCommand | stream-chat | (name: string): Promise<GetCommandResponse> |
StreamChat.getDevices | stream-chat | (userID?: string | undefined): Promise<APIResponse & { devices?: Device[] | undefined; }> |
StreamChat.getSegment | stream-chat | (id: string): Promise<{ segment: SegmentResponse; } & APIResponse> |
StreamChat.unflagUser | stream-chat | (targetID: string, options?: { user_id?: string | undefined; } | undefined): Promise<FlagUserResponse> |
StreamChat.unmuteUser | stream-chat | (targetID: string, currentUserID?: string | undefined): Promise<APIResponse> |
StreamChat.updateUser | stream-chat | (userObject: UserResponse): Promise<UpdateUsersAPIResponse> |
StreamChat.upsertUser | stream-chat | (userObject: UserResponse): Promise<UpdateUsersAPIResponse> |
StreamChat.wsFallback | stream-chat | WSConnectionFallback | undefined |
StreamChat._queryFlags | stream-chat | (filterConditions?: FlagsFilters | undefined, options?: FlagsPaginationOptions | undefined): Promise<FlagsResponse> |
StreamChat.createToken | stream-chat | (userID: string, exp?: number | undefined, iat?: number | undefined): string |
StreamChat.deleteUsers | stream-chat | (user_ids: string[], options?: DeleteUserOptions | undefined): Promise<APIResponse & TaskResponse> |
StreamChat.exportUsers | stream-chat | (request: ExportUsersRequest): Promise<APIResponse & ExportUsersResponse> |
StreamChat.flagMessage | stream-chat | (targetMessageID: string, options?: { custom?: Record<string, unknown> | undefined; reason?: string | undefined; user_id?: string | undefined; } | undefined): Promise<FlagMessageResponse> |
StreamChat.getCampaign | stream-chat | (id: string, options?: GetCampaignOptions | undefined): Promise<{ campaign: CampaignResponse; users: { next?: string | undefined; prev?: string | undefined; }; } & APIResponse> |
StreamChat.markAllRead | stream-chat | (data?: MarkChannelsReadOptions | undefined): Promise<void> |
StreamChat.unBlockUser | stream-chat | (blockedUserID: string, userID?: string | undefined): Promise<APIResponse> |
StreamChat.updateFlags | stream-chat | (message_ids: string[], reviewed_by: string, options?: { user_id?: string | undefined; } | undefined): Promise<APIResponse> |
StreamChat.upsertUsers | stream-chat | (users: UserResponse[]): Promise<UpdateUsersAPIResponse> |
StreamChat._listImports | stream-chat | (options: ListImportsPaginationOptions): Promise<APIResponse & ListImportsResponse> |
StreamChat._logApiError | stream-chat | (type: string, url: string, error: unknown): void |
StreamChat.getBlockList | stream-chat | (name: string, data?: { team?: string | undefined; } | undefined): Promise<APIResponse & { blocklist: BlockListResponse; }> |
StreamChat.listCommands | stream-chat | (): Promise<ListCommandsResponse> |
StreamChat.recoverState | stream-chat | (): Promise<void> |
StreamChat.removeDevice | stream-chat | (id: string, userID?: string | undefined): Promise<APIResponse> |
StreamChat.restoreUsers | stream-chat | (user_ids: string[]): Promise<APIResponse> |
StreamChat.stopCampaign | stream-chat | (id: string): Promise<{ campaign: CampaignResponse; }> |
StreamChat._cacheEnabled | stream-chat | (): boolean |
StreamChat._createImport | stream-chat | (path: string, options?: CreateImportOptions | undefined): Promise<APIResponse & CreateImportResponse> |
StreamChat.addPollAnswer | stream-chat | (messageId: string, pollId: string, answerText: string, userId?: string | undefined): Promise<APIResponse & CastVoteAPIResponse> |
StreamChat.commitMessage | stream-chat | (id: string): Promise<APIResponse & CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefi… |
StreamChat.createCommand | stream-chat | (data: CreateCommandOptions): Promise<CreateCommandResponse> |
StreamChat.createSegment | stream-chat | (type: SegmentType, id: string | null, data?: SegmentData | undefined): Promise<{ segment: SegmentResponse; }> |
StreamChat.deleteCommand | stream-chat | (name: string): Promise<DeleteCommandResponse> |
StreamChat.deleteSegment | stream-chat | (id: string): Promise<APIResponse> |
StreamChat.exportChannel | stream-chat | (request: ExportChannelRequest, options?: ExportChannelOptions | undefined): Promise<APIResponse & ExportChannelResponse> |
StreamChat.getHookEvents | stream-chat | (products?: Product[] | undefined): Promise<GetHookEventsResponse> |
StreamChat.getPermission | stream-chat | (name: string): Promise<PermissionAPIResponse> |
StreamChat.getRateLimits | stream-chat | (params?: { android?: boolean | undefined; endpoints?: EndpointName[] | undefined; ios?: boolean | undefined; serverSide?: boolean | undefined; web?: boolean | undefined; } | undefined): Promise<GetRateLimitsResponse> |
StreamChat.querySegments | stream-chat | (filter: {}, sort?: SortParam[] | undefined, options?: Pager | undefined): Promise<{ segments: SegmentResponse[]; next?: string | undefined; prev?: string | undefined; } & APIResponse> |
StreamChat.startCampaign | stream-chat | (id: string, options?: { scheduledFor?: string | undefined; stopAt?: string | undefined; } | undefined): Promise<{ campaign: CampaignResponse; users: { next?: string | undefined; prev?: string | undefined; }; } & APIResponse> |
StreamChat.unflagMessage | stream-chat | (targetMessageID: string, options?: { user_id?: string | undefined; } | undefined): Promise<FlagMessageResponse> |
StreamChat.updateCommand | stream-chat | (name: string, data: UpdateCommandOptions): Promise<UpdateCommandResponse> |
StreamChat.updateSegment | stream-chat | (id: string, data: Partial<UpdateSegmentData>): Promise<{ segment: SegmentResponse; }> |
StreamChat.verifyWebhook | stream-chat | (requestBody: any, xSignature: string): boolean |
StreamChat._deleteMessage | stream-chat | (messageID: string, optionsOrHardDelete?: boolean | DeleteMessageOptions | undefined): Promise<APIResponse & { message: MessageResponse; }> |
StreamChat._logApiRequest | stream-chat | (type: string, url: string, data: unknown, config: any): void |
StreamChat._normalizeDate | stream-chat | (before: string | Date | null): string | null |
StreamChat._updateMessage | stream-chat | (message: LocalMessage | Partial<MessageResponse>, partialUserOrUserId?: string | { id: string; } | undefined, options?: UpdateMessageOptions | undefined): Promise<UpdateMessageAPIResponse> |
StreamChat.activeChannels | stream-chat | { [key: string]: Channel; } |
StreamChat.createCampaign | stream-chat | (params: CampaignData): Promise<{ campaign: CampaignResponse; users: { next?: string | undefined; prev?: string | undefined; }; } & APIResponse> |
StreamChat.deactivateUser | stream-chat | (userID: string, options?: DeactivateUsersOptions | undefined): Promise<APIResponse & { user: UserResponse; }> |
StreamChat.deleteCampaign | stream-chat | (id: string): Promise<APIResponse> |
StreamChat.doAxiosRequest | stream-chat | <T>(type: string, url: string, data?: unknown, options?: any): Promise<T> |
StreamChat.exportChannels | stream-chat | (request: ExportChannelRequest[], options?: ExportChannelOptions | undefined): Promise<APIResponse & ExportChannelResponse> |
StreamChat.getChannelById | stream-chat | (channelType: string, channelID: string, custom: ChannelData): Channel |
StreamChat.getChannelType | stream-chat | (channelType: string): Promise<GetChannelTypeResponse> |
StreamChat.getUnreadCount | stream-chat | (userID?: string | undefined): Promise<GetUnreadCountAPIResponse> |
StreamChat.handleResponse | stream-chat | <T>(response: AxiosResponse<T>): T |
StreamChat.insightMetrics | stream-chat | InsightMetrics |
StreamChat.queryCampaigns | stream-chat | (filter: CampaignFilters, sort?: CampaignSort | undefined, options?: CampaignQueryOptions | undefined): Promise<{ campaigns: CampaignResponse[]; next?: string | undefined; prev?: string | undefined; } & APIResponse> |
StreamChat.reactivateUser | stream-chat | (userID: string, options?: ReactivateUserOptions | undefined): Promise<APIResponse & { user: UserResponse; }> |
StreamChat.removePollVote | stream-chat | (messageId: string, pollId: string, voteId: string, userId?: string | undefined): Promise<APIResponse & { vote: PollVote; }> |
StreamChat.setLocalDevice | stream-chat | (device: BaseDeviceFields): void |
StreamChat.unblockMessage | stream-chat | (targetMessageID: string, options?: { user_id?: string | undefined; } | undefined): Promise<APIResponse> |
StreamChat.updateCampaign | stream-chat | (id: string, params: Partial<CampaignData>): Promise<{ campaign: CampaignResponse; users: { next?: string | undefined; prev?: string | undefined; }; }> |
StreamChat.updateLocation | stream-chat | (location: UpdateLocationPayload): Promise<SharedLocationResponse> |
StreamChat._buildWSPayload | stream-chat | (client_request_id?: string | undefined): string |
StreamChat._logApiResponse | stream-chat | <T>(type: string, url: string, response: AxiosResponse<T>): void |
StreamChat._unblockMessage | stream-chat | (targetMessageID: string, options?: { user_id?: string | undefined; } | undefined): Promise<APIResponse> |
StreamChat.deactivateUsers | stream-chat | (user_ids: string[], options?: DeactivateUsersOptions | undefined): Promise<APIResponse & TaskResponse> |
StreamChat.listPermissions | stream-chat | (): Promise<PermissionsAPIResponse> |
StreamChat.queryUserGroups | stream-chat | (options?: QueryUserGroupsOptions | undefined): Promise<QueryUserGroupsResponse> |
StreamChat.reactivateUsers | stream-chat | (user_ids: string[], options?: ReactivateUsersOptions | undefined): Promise<APIResponse & TaskResponse> |
StreamChat.removeShadowBan | stream-chat | (targetUserID: string, options?: UnBanUserOptions | undefined): Promise<APIResponse> |
StreamChat.revokeUserToken | stream-chat | (userID: string, before?: string | Date | null | undefined): Promise<UpdateUsersAPIResponse> |
StreamChat.testSNSSettings | stream-chat | (data?: TestSNSDataInput | undefined): Promise<CheckSNSResponse> |
StreamChat.testSQSSettings | stream-chat | (data?: TestSQSDataInput | undefined): Promise<CheckSQSResponse> |
StreamChat.undeleteMessage | stream-chat | (messageID: string, userID: string): Promise<APIResponse & { message: MessageResponse; }> |
StreamChat._createImportURL | stream-chat | (filename: string): Promise<APIResponse & CreateImportURLResponse> |
StreamChat._setupConnection | stream-chat | (): ConnectAPIResponse | undefined |
StreamChat.createPermission | stream-chat | (permissionData: CustomPermissionOptions): Promise<APIResponse> |
StreamChat.defaultWSTimeout | stream-chat | number |
StreamChat.deletePermission | stream-chat | (name: string): Promise<APIResponse> |
StreamChat.listChannelTypes | stream-chat | (): Promise<ListChannelResponse> |
StreamChat.revokeUsersToken | stream-chat | (userIDs: string[], before?: string | Date | null | undefined): Promise<UpdateUsersAPIResponse> |
StreamChat.setAnonymousUser | stream-chat | (): ConnectAPIResponse | undefined |
StreamChat.testPushSettings | stream-chat | (userID: string, data?: TestPushDataInput | undefined): Promise<CheckPushResponse> |
StreamChat.updatePermission | stream-chat | (id: string, permissionData: Omit<CustomPermissionOptions, "id">): Promise<APIResponse> |
StreamChat._queryFlagReports | stream-chat | (filterConditions?: FlagReportsFilters | undefined, options?: FlagReportsPaginationOptions | undefined): Promise<FlagReportsResponse> |
StreamChat._reviewFlagReport | stream-chat | (id: string, reviewResult: string, options?: ReviewFlagReportOptions | undefined): Promise<ReviewFlagReportResponse> |
StreamChat.addSegmentTargets | stream-chat | (id: string, targets: string[]): Promise<APIResponse> |
StreamChat.createChannelType | stream-chat | (data: CreateChannelOptions): Promise<CreateChannelResponse> |
StreamChat.createUserSegment | stream-chat | (id: string | null, data?: SegmentData | undefined): Promise<{ segment: SegmentResponse; }> |
StreamChat.deleteChannelType | stream-chat | (channelType: string): Promise<APIResponse> |
StreamChat.errorFromResponse | stream-chat | (response: AxiosResponse<APIErrorResponse>): ErrorFromResponse<APIErrorResponse> |
StreamChat.listPushProviders | stream-chat | (): Promise<APIResponse & PushProviderListResponse> |
StreamChat.partialUpdatePoll | stream-chat | (id: string, partialPollObject: PartialPollUpdate, userId?: string | undefined): Promise<APIResponse & UpdatePollAPIResponse> |
StreamChat.partialUpdateUser | stream-chat | (partialUserObject: PartialUserUpdate): Promise<UpdateUsersAPIResponse> |
StreamChat.updateAppSettings | stream-chat | (options: AppSettings): Promise<APIResponse> |
StreamChat.updateChannelType | stream-chat | (channelType: string, data: UpdateChannelTypeRequest): Promise<UpdateChannelTypeResponse> |
StreamChat._isUsingServerAuth | stream-chat | (): boolean |
StreamChat.deletePushProvider | stream-chat | ({ type, name }: PushProviderID): Promise<APIResponse> |
StreamChat.getSharedLocations | stream-chat | (): Promise<ActiveLiveLocationsAPIResponse> |
StreamChat.partialUpdateUsers | stream-chat | (users: PartialUserUpdate[]): Promise<UpdateUsersAPIResponse> |
StreamChat.setPushPreferences | stream-chat | (preferences: PushPreference[]): Promise<UpsertPushPreferencesResponse> |
StreamChat.upsertPushProvider | stream-chat | (pushProvider: PushProviderConfig): Promise<APIResponse & PushProviderUpsertResponse> |
StreamChat._enrichAxiosOptions | stream-chat | (options?: any): AxiosRequestConfig |
StreamChat.channelBatchUpdater | stream-chat | (): ChannelBatchUpdater |
StreamChat.consecutiveFailures | stream-chat | number |
StreamChat.getChannelByMembers | stream-chat | (channelType: string, custom: ChannelData): Channel |
StreamChat.getUnreadCountBatch | stream-chat | (userIDs: string[]): Promise<GetUnreadCountBatchAPIResponse> |
StreamChat.partialUpdateThread | stream-chat | (messageId: string, partialThreadObject: PartialThreadUpdate): Promise<GetThreadAPIResponse> |
StreamChat.queryMessageHistory | stream-chat | (filter?: QueryMessageHistoryFilters | undefined, sort?: QueryMessageHistorySort | undefined, options?: Pager | undefined): Promise<APIResponse & QueryMessageHistoryResponse> |
StreamChat.querySegmentTargets | stream-chat | (id: string, filter?: QuerySegmentTargetsFilter | null | undefined, sort?: SortParam[] | [] | null | undefined, options?: {} | undefined): Promise<{ targets: SegmentTargetsResponse[]; next?: string | undefined; } & APIResponse> |
StreamChat.queryTeamUsageStats | stream-chat | (options?: QueryTeamUsageStatsOptions | undefined): Promise<QueryTeamUsageStatsResponse> |
StreamChat.segmentTargetExists | stream-chat | (segmentId: string, targetId: string): Promise<APIResponse> |
StreamChat.sendUserCustomEvent | stream-chat | (targetUserID: string, event: UserCustomEvent): Promise<APIResponse> |
StreamChat._normalizeExpiration | stream-chat | (timeoutOrExpirationDate?: string | number | Date | null | undefined): string | null |
StreamChat.createChannelManager | stream-chat | ({ eventHandlerOverrides, options, queryChannelsOverride, }: { eventHandlerOverrides?: Partial<Record<ChannelManagerEventHandlerNames, EventHandlerOverrideType>> | undefined; options?: ChannelManagerOptions | undefined; queryChannelsOverride?: QueryChannelsRequestType | undefined; }): ChannelManager |
StreamChat.createChannelSegment | stream-chat | (id: string | null, data?: SegmentData | undefined): Promise<{ segment: SegmentResponse; }> |
StreamChat.partialUpdateMessage | stream-chat | (id: string, partialMessageObject: PartialMessageUpdate, partialUserOrUserId?: string | { id: string; } | undefined, options?: UpdateMessageOptions | undefined): Promise<UpdateMessageAPIResponse> |
StreamChat.queryChannelsRequest | stream-chat | (filterConditions: ChannelFilters, sort?: ChannelSort | undefined, options?: ChannelOptions | undefined): Promise<Omit<ChannelAPIResponse, keyof APIResponse>[]> |
StreamChat.removeSegmentTargets | stream-chat | (id: string, targets: string[]): Promise<APIResponse> |
StreamChat.hydrateActiveChannels | stream-chat | (channelsFromApi?: ChannelAPIResponse[] | undefined, stateOptions?: ChannelStateOptions | undefined, queryChannelsOptions?: ChannelOptions | undefined): Channel[] |
StreamChat.verifyAndParseWebhook | stream-chat | (rawBody: any, signature: string): Event |
StreamChat.ephemeralUpdateMessage | stream-chat | (messageId: string, partialMessageObject: PartialMessageUpdate, partialUserOrUserId?: string | { id: string; } | undefined, options?: UpdateMessageOptions | undefined): Promise<UpdateMessageAPIResponse> |
StreamChat.getExportChannelStatus | stream-chat | (id: string): Promise<APIResponse & ExportChannelStatusResponse> |
StreamChat.validateServerSideAuth | stream-chat | (): void |
StreamChat.recoverStateOnReconnect | stream-chat | boolean | undefined |
StreamChat._validateAndGetMessageId | stream-chat | (messageOrMessageId: string | { id: string; }, errorText: string): string |
StreamChat._messageComposerSetupState | stream-chat | StateStore<MessageComposerSetupState> |
StreamChat.nextRequestAbortController | stream-chat | any |
StreamChat.defaultWSTimeoutWithFallback | stream-chat | number |
StreamChat.persistUserOnConnectionFailure | stream-chat | boolean | undefined |
StreamChat.queryChannelsRequestWithResponse | stream-chat | (filterConditions: ChannelFilters, sort?: ChannelSort | undefined, options?: ChannelOptions | undefined, requestOptions?: RequestOptions | undefined): Promise<QueryChannelsAPIResponse> |
StreamChat.createAbortControllerForNextRequest | stream-chat | (): AbortController |
ChannelState.threads | stream-chat | Record<string, LocalMessage[]> |
ChannelState.messages | stream-chat | LocalMessage[] |
ChannelState.isUpToDate | stream-chat | boolean |
ChannelState.mutedUsers | stream-chat | UserResponse[] |
ChannelState.addReaction | stream-chat | (reaction: ReactionResponse, message?: MessageResponse | undefined, enforce_unique?: boolean | undefined): MessageResponse | LocalMessage | undefined |
ChannelState.findMessage | stream-chat | (messageId: string, parentMessageId?: string | undefined): LocalMessage | undefined |
ChannelState.messageSets | stream-chat | MessageSet[] |
ChannelState.pruneOldest | stream-chat | (maxMessages: number): void |
ChannelState.initMessages | stream-chat | (): void |
ChannelState.clearMessages | stream-chat | (): void |
ChannelState.removeMessage | stream-chat | (messageToRemove: { id: string; messageSetIndex?: number | undefined; parent_id?: string | undefined; }): boolean |
ChannelState.setIsUpToDate | stream-chat | (isUpToDate: boolean): void |
ChannelState._updateMessage | stream-chat | (message: { id?: string | undefined; parent_id?: string | undefined; pinned?: boolean | undefined; show_in_channel?: boolean | undefined; }, updateFunc: (msg: LocalMessage) => LocalMessage): void |
ChannelState.latestMessages | stream-chat | LocalMessage[] |
ChannelState.pinnedMessages | stream-chat | LocalMessage[] |
ChannelState.removeReaction | stream-chat | (reaction: ReactionResponse, message?: MessageResponse | undefined): MessageResponse | undefined |
ChannelState.last_message_at | stream-chat | Date | null |
ChannelState.addMessageSorted | stream-chat | (newMessage: MessageResponse | LocalMessage, timestampChanged?: boolean | undefined, addIfDoesNotExist?: boolean | undefined, messageSetToAddToIfDoesNotExist?: MessageSetType | undefined): { messageSet: MessageSet; filteredMessageIds: string[]; } |
ChannelState.addPinnedMessage | stream-chat | (pinnedMessage: MessageResponse): void |
ChannelState._addToMessageList | stream-chat | (messages: LocalMessage[], message: LocalMessage, timestampChanged?: boolean | undefined, sortBy?: "created_at" | "pinned_at" | undefined, addIfDoesNotExist?: boolean | undefined): LocalMessage[] |
ChannelState.addMessagesSorted | stream-chat | (newMessages: (MessageResponse | LocalMessage)[], timestampChanged?: boolean | undefined, initializing?: boolean | undefined, addIfDoesNotExist?: boolean | undefined, messageSetToAddToIfDoesNotExist?: MessageSetType | undefined): { messageSet: MessageSet; filteredMessageIds: string[]; } |
ChannelState.addPinnedMessages | stream-chat | (pinnedMessages: MessageResponse[]): void |
ChannelState.messagePagination | stream-chat | Readonly<{ hasNext: false; hasPrev: false; }> | { hasNext: boolean; hasPrev: boolean; } |
ChannelState.deleteUserMessages | stream-chat | (user: UserResponse, hardDelete?: boolean | undefined, deletedAt?: Date | null | undefined): void |
ChannelState.switchToMessageSet | stream-chat | any |
ChannelState.updateUserMessages | stream-chat | (user: UserResponse): void |
ChannelState._addReactionToState | stream-chat | (messageFromState: LocalMessage, reaction: ReactionResponse, enforce_unique?: boolean | undefined): LocalMessage |
ChannelState.filterErrorMessages | stream-chat | (): void |
ChannelState.findMessageSetIndex | stream-chat | any |
ChannelState.removePinnedMessage | stream-chat | (message: MessageResponse): void |
ChannelState.findTargetMessageSet | stream-chat | any |
ChannelState.loadMessageIntoState | stream-chat | (messageId: string, parentMessageId?: string | undefined, limit?: number | undefined): Promise<void> |
ChannelState.areMessageSetsOverlap | stream-chat | any |
ChannelState.findMessageByTimestamp | stream-chat | (timestampMs: number, parentMessageId?: string | undefined, exactTsMatch?: boolean | undefined): LocalMessage | null |
ChannelState.removeMessageFromArray | stream-chat | (msgArray: LocalMessage[], msg: { id: string; parent_id?: string | undefined; }): { removed: boolean; result: LocalMessage[]; } |
ChannelState._addOwnReactionToMessage | stream-chat | (ownReactions: ReactionResponse[] | null | undefined, reaction: ReactionResponse, enforce_unique?: boolean | undefined): ReactionResponse[] |
ChannelState._removeReactionFromState | stream-chat | (messageFromState: LocalMessage, reaction: ReactionResponse): LocalMessage |
ChannelState._removeOwnReactionFromMessage | stream-chat | (ownReactions: ReactionResponse[] | null | undefined, reaction: ReactionResponse): ReactionResponse[] | null | undefined |
ChannelState.removeQuotedMessageReferences | stream-chat | (message: MessageResponse): void |
ChannelState._updateQuotedMessageReferences | stream-chat | ({ message, remove, }: { message: MessageResponse; remove?: boolean | undefined; }): void |
ChannelState._dropLatestMessagesDisjointFrom | stream-chat | (newestPage: (MessageResponse | LocalMessage)[]): void |
ChannelState.findMessageSetByOldestTimestamp | stream-chat | any |
PollComposer.user_id | stream-chat | string | undefined |
TokenManager.secret | stream-chat | any |
BasePaginator.next | stream-chat | (): Promise<void> |
BasePaginator.prev | stream-chat | (): Promise<void> |
BasePaginator.query | stream-chat | (params: PaginationQueryParams): Promise<PaginationQueryReturnValue<T>> |
BasePaginator.hasNext | stream-chat | boolean |
BasePaginator.hasPrev | stream-chat | boolean |
BasePaginator.nextDebounced | stream-chat | (): void |
BasePaginator.prevDebounced | stream-chat | (): void |
BasePaginator._isCursorPagination | stream-chat | boolean |
ThreadManager.threadsById | stream-chat | Record<string, Thread | undefined> |
ThreadManager.loadNextPage | stream-chat | (options?: Omit<QueryThreadsOptions, "next"> | undefined): Promise<void> |
ThreadManager.queryThreads | stream-chat | (options?: QueryThreadsOptions | undefined): Promise<{ threads: Thread[]; next: string | undefined; }> |
ThreadManager.threadsByIdGetterCache | stream-chat | any |
ThreadManager.subscribeChannelDeleted | stream-chat | any |
ThreadManager.subscribeRecoverAfterConnectionDrop | stream-chat | any |
ChannelManager.id | stream-chat | any |
ChannelManager.options | stream-chat | any |
ChannelManager.loadNext | stream-chat | (): Promise<void> |
ChannelManager.setOptions | stream-chat | (options?: ChannelManagerOptions | undefined): void |
ChannelManager.setChannels | stream-chat | (valueOrFactory: ChannelSetterParameterType): void |
ChannelManager.stateOptions | stream-chat | any |
ChannelManager.eventHandlers | stream-chat | any |
ChannelManager.queryChannels | stream-chat | (filters: ChannelFilters, sort?: ChannelSort | undefined, options?: ChannelOptions | undefined, stateOptions?: ChannelStateOptions | undefined): Promise<void> |
ChannelManager.newMessageHandler | stream-chat | any |
ChannelManager.channelHiddenHandler | stream-chat | any |
ChannelManager.executeChannelsQuery | stream-chat | any |
ChannelManager.memberUpdatedHandler | stream-chat | any |
ChannelManager.queryChannelsRequest | stream-chat | any |
ChannelManager.channelDeletedHandler | stream-chat | any |
ChannelManager.channelVisibleHandler | stream-chat | any |
ChannelManager.eventHandlerOverrides | stream-chat | any |
ChannelManager.subscriptionOrOverride | stream-chat | any |
ChannelManager.setQueryChannelsRequest | stream-chat | (queryChannelsRequest: QueryChannelsRequestType): void |
ChannelManager.setEventHandlerOverrides | stream-chat | (eventHandlerOverrides?: Partial<Record<ChannelManagerEventHandlerNames, EventHandlerOverrideType>> | undefined): void |
ChannelManager.notificationNewMessageHandler | stream-chat | any |
ChannelManager.notificationAddedToChannelHandler | stream-chat | any |
ChannelManager.notificationRemovedFromChannelHandler | stream-chat | any |
ThreadResponse.read | stream-chat | ReadResponse[] | undefined |
ThreadResponse.draft | stream-chat | DraftResponse | undefined |
ThreadResponse.latest_replies | stream-chat | MessageResponse[] |
SearchController._internalState | stream-chat | StateStore<InternalSearchControllerState> |
AbstractOfflineDB.handleOfflineFailedUpdateMessagePendingTask | stream-chat | any |
AbstractOfflineDB.mergeFailedMessageUpdateIntoPendingSendMessage | stream-chat | any |
AttachmentManager.uploadAttachment | stream-chat | (attachment: LocalUploadAttachment): Promise<LocalUploadAttachment | undefined> |
AttachmentManager.ensureLocalUploadAttachment | stream-chat | any |
ReminderPaginator.next | stream-chat | (): Promise<void> |
ReminderPaginator.prev | stream-chat | (): Promise<void> |
ReminderPaginator.query | stream-chat | ({ direction, }: PaginationQueryParams): Promise<PaginationQueryReturnValue<ReminderResponse>> |
ReminderPaginator.hasNext | stream-chat | boolean |
ReminderPaginator.hasPrev | stream-chat | boolean |
ReminderPaginator.nextDebounced | stream-chat | (): void |
ReminderPaginator.prevDebounced | stream-chat | (): void |
ReminderPaginator._isCursorPagination | stream-chat | boolean |
StableWSConnection._log | stream-chat | (msg: string, extra?: UR | undefined, level?: LogLevel | undefined): void |
StableWSConnection.setClient | stream-chat | (client: StreamChat): void |
StableWSConnection.connectionID | stream-chat | string | undefined |
UserGroupPaginator.next | stream-chat | (): Promise<void> |
UserGroupPaginator.prev | stream-chat | (): Promise<void> |
UserGroupPaginator.query | stream-chat | ({ direction, }: PaginationQueryParams): Promise<PaginationQueryReturnValue<UserGroupResponse>> |
UserGroupPaginator.hasNext | stream-chat | boolean |
UserGroupPaginator.hasPrev | stream-chat | boolean |
UserGroupPaginator.nextDebounced | stream-chat | (): void |
UserGroupPaginator.prevDebounced | stream-chat | (): void |
UserGroupPaginator._isCursorPagination | stream-chat | boolean |
OfflineDBSyncManager.syncStatus | stream-chat | boolean |
Anggota kelas atau antarmuka yang berubah
| member | Sebelum | Sesudah |
|---|---|---|
Poll.close | (): Promise<(APIResponse & UpdatePollAPIResponse) | undefined> | (): Promise<StreamResponse<PollResponse> | undefined> |
Poll.query | (id: string): Promise<PollResponse> | (id: string): Promise<PollResponseData> |
Poll.delete | (): Promise<APIResponse> | (): Promise<StreamResponse<Response>> |
Poll.update | (data: PollData): Promise<APIResponse & UpdatePollAPIResponse> | (data: Omit<UpdatePollRequest, "id">): Promise<StreamResponse<PollResponse>> |
Poll.castVote | (optionId: string, messageId: string): Promise<(APIResponse & CastVoteAPIResponse) | undefined> | (optionId: string, messageId: string): Promise<StreamResponse<PollVoteResponse> | undefined> |
Poll.addAnswer | (answerText: string, messageId: string): Promise<APIResponse & CastVoteAPIResponse> | (answerText: string, messageId: string): Promise<StreamResponse<PollVoteResponse>> |
Poll.removeVote | (voteId: string, messageId: string): Promise<(APIResponse & { vote: PollVote; }) | undefined> | (voteId: string, messageId: string): Promise<StreamResponse<PollVoteResponse> | undefined> |
Poll.createOption | (option: PollOptionData): Promise<APIResponse & CreatePollOptionAPIResponse> | (option: CreatePollOptionRequest): Promise<StreamResponse<PollOptionResponse>> |
Poll.deleteOption | (optionId: string): Promise<APIResponse> | (option_id: string): Promise<StreamResponse<Response>> |
Poll.queryAnswers | (params: PollAnswersQueryParams): Promise<APIResponse & PollAnswersAPIResponse> | (params: PollAnswersQueryParams): Promise<StreamResponse<PollVotesResponse>> |
Poll.removeAnswer | (answerId: string, messageId: string): Promise<APIResponse & { vote: PollVote; }> | (answerId: string, messageId: string): Promise<StreamResponse<PollVoteResponse>> |
Poll.updateOption | (option: PollOptionData): Promise<APIResponse & CreatePollOptionAPIResponse> | (option: UpdatePollOptionRequest): Promise<StreamResponse<PollOptionResponse>> |
Poll.partialUpdate | (partialPollObject: PartialPollUpdate): Promise<APIResponse & UpdatePollAPIResponse> | (partialPollObject: PartialPollUpdate): Promise<StreamResponse<PollResponse>> |
Poll.handlePollClosed | (event: Event): void | (event: { type: "poll.closed"; } & PollClosedEvent & { received_at?: TimestampNS | undefined; }): void |
Poll.handleVoteCasted | (event: Event): void | (event: { type: "poll.vote_casted"; } & PollVoteCastedEvent & { received_at?: TimestampNS | undefined; }): void |
Poll.queryOptionVotes | (params: PollOptionVotesQueryParams): Promise<APIResponse & PollVotesAPIResponse> | (params: PollOptionVotesQueryParams): Promise<StreamResponse<PollVotesResponse>> |
Poll.handlePollUpdated | (event: Event): void | (event: { type: "poll.updated"; } & PollUpdatedEvent & { received_at?: TimestampNS | undefined; }): void |
Poll.handleVoteChanged | (event: Event): void | (event: { type: "poll.vote_changed"; } & PollVoteChangedEvent & { received_at?: TimestampNS | undefined; }): void |
Poll.handleVoteRemoved | (event: Event): void | (event: { type: "poll.vote_removed"; } & PollVoteRemovedEvent & { received_at?: TimestampNS | undefined; }): void |
Poll.reinitializeState | (poll: PollResponse): void | (poll: PollResponseData): void |
Thread.activate | (): void | (): () => void |
Thread.markAsRead | ({ force }?: { force?: boolean | undefined; } | undefined): Promise<EventAPIResponse | null> | ({ force }?: { force?: boolean | undefined; } | undefined): Promise<Partial<StreamResponse<MarkReadResponse>> | null> |
Thread.constructor | ({ client, threadData, }: { client: StreamChat; threadData: ThreadResponse; }): Thread | ({ client, threadData, channel, parentMessage, draft, }: { client: StreamChat; threadData?: ThreadStateResponse | undefined; channel?: Channel | undefined; parentMessage?: MessageResponse | LocalMessage | undefined; draft?: DraftResponse | undefined; }): Thread |
Thread.hydrateState | (thread: Thread): void | (threadData: ThreadStateResponse, options?: { reconcile?: ReconcileNewestMessagesOptions | undefined; } | undefined): void |
Thread.upsertReplyLocally | ({ message, timestampChanged, }: { message: MessageResponse | LocalMessage; timestampChanged?: boolean | undefined; }): void | ({ message, }: { message: MessageResponse | LocalMessage; timestampChanged?: boolean | undefined; }): void |
Channel.on | (eventType: EventTypes, callback: EventHandler): { unsubscribe: () => void; } | (callback: EventHandler): { unsubscribe: () => void; } | <T extends EventType>(eventType: T, callback: EventHandler<T>): { unsubscribe: () => void; } | (callback: EventHandler): { unsubscribe: () => void; } |
Channel.off | (eventType: EventTypes, callback: EventHandler): void | (callback: EventHandler): void | <T extends EventType>(eventType: T, callback: EventHandler<T>): void | (callback: EventHandler): void |
Channel.pin | (opts?: { user_id?: string | undefined; } | undefined): Promise<ChannelMemberResponse> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateMemberPartialResponse>> |
Channel.data | Partial<CustomChannelData & Partial<{ blocked: boolean; created_by: UserResponse | null; created_by_id: string; members: string[] | NewMemberPayload[]; blocklist_behavior: AutomodBehavior; automod: Automod; filter_tags: string[]; team?: string | undefined; }> & { cid: string; disabled: boolean; froz… | Partial<ChannelResponse> | undefined |
Channel.hide | (userId?: string | null | undefined, clearHistory?: boolean | undefined): Promise<APIResponse> | (request?: HideChannelRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<HideChannelResponse>> |
Channel.mute | (opts?: { expiration?: number | undefined; user_id?: string | undefined; } | undefined): Promise<MuteChannelAPIResponse> | (options?: MuteChannelRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<MuteChannelResponse>> |
Channel.show | (userId?: string | null | undefined): Promise<APIResponse> | (request?: ShowChannelRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<ShowChannelResponse>> |
Channel.vote | (messageId: string, pollId: string, vote: PollVoteData): Promise<APIResponse & CastVoteAPIResponse> | (pathParams: { message_id: string; poll_id: string; }, request?: CastPollVoteRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollVoteResponse>> |
Channel._data | Partial<CustomChannelData & Partial<{ blocked: boolean; created_by: UserResponse | null; created_by_id: string; members: string[] | NewMemberPayload[]; blocklist_behavior: AutomodBehavior; automod: Automod; filter_tags: string[]; team?: string | undefined; }> & { cid: string; disabled: boolean; froz… | ChannelInput |
Channel.query | (options?: ChannelQueryOptions | undefined, messageSetToAddToIfDoesNotExist?: MessageSetType | undefined): Promise<QueryChannelAPIResponse> | (options?: ChannelGetOrCreateRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<ChannelStateResponse>> |
Channel.unpin | (opts?: { user_id?: string | undefined; } | undefined): Promise<ChannelMemberResponse> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateMemberPartialResponse>> |
Channel.watch | (options?: ChannelQueryOptions | undefined): Promise<QueryChannelAPIResponse> | (options?: ChannelGetOrCreateRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<Channel> |
Channel.create | (options?: ChannelQueryOptions | undefined): Promise<QueryChannelAPIResponse> | (options?: ChannelGetOrCreateRequest | undefined): Promise<StreamResponse<ChannelStateResponse>> |
Channel.delete | (options?: { hard_delete?: boolean | undefined; } | undefined): Promise<DeleteChannelAPIResponse> | (request?: { hard_delete?: boolean | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<DeleteChannelResponse>> |
Channel.unmute | (opts?: { user_id?: string | undefined; } | undefined): Promise<APIResponse> | (options?: UnmuteChannelRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UnmuteResponse>> |
Channel.update | (channelData?: Partial<CustomChannelData & Partial<{ blocked: boolean; created_by: UserResponse | null; created_by_id: string; members: string[] | NewMemberPayload[]; blocklist_behavior: AutomodBehavior; automod: Automod; filter_tags: string[]; team?: string | undefined; }> & { cid: string; disabled… | (request?: UpdateChannelRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.archive | (opts?: { user_id?: string | undefined; } | undefined): Promise<ChannelMemberResponse> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateMemberPartialResponse>> |
Channel.banUser | (targetUserID: string, options: BanUserOptions): Promise<APIResponse> | (targetUserId: string, options: Omit<BanUserOptions, "channel_cid">): Promise<StreamResponse<ModerationBanResponse>> |
Channel.getDraft | ({ parent_id }?: { parent_id?: string | undefined; } | undefined): Promise<GetDraftResponse> | (request?: { parent_id?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<GetDraftResponse>> |
Channel.lastRead | (): Date | null | undefined | (): TimestampNS | null | undefined |
Channel.markRead | (data?: MarkReadOptions | undefined): Promise<EventAPIResponse | null> | (request?: MarkReadRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<MarkReadResponse>> |
Channel.truncate | (options?: TruncateOptions | undefined): Promise<TruncateChannelAPIResponse> | (request?: TruncateChannelRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<TruncateChannelResponse>> |
Channel.keystroke | (parent_id?: string | undefined, options?: { user_id: string; } | undefined): Promise<void> | (parentId?: string | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<void> |
Channel.listeners | { [key: string]: (string | EventHandler)[]; } | Map<EventType, Set<EventHandler>> |
Channel.sendEvent | (event: Event): Promise<EventAPIResponse> | (request: SendEventRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<EventResponse>> |
Channel.unarchive | (opts?: { user_id?: string | undefined; } | undefined): Promise<ChannelMemberResponse> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateMemberPartialResponse>> |
Channel.unbanUser | (targetUserID: string, options?: UnBanUserOptions | undefined): Promise<APIResponse> | (targetUserId: string, options?: UnBanUserOptions | undefined): Promise<APIResponse> |
Channel.addMembers | (members: string[] | NewMemberPayload[], message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?:… | ({ members, ...options }: AddMembersRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.deleteFile | (url: string): Promise<APIResponse> | (request: { url: string; }, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
Channel.markUnread | (data: MarkUnreadOptions): Promise<APIResponse | null> | (request?: MarkUnreadRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
Channel.muteStatus | (): { createdAt: Date | null; expiresAt: Date | null; muted: boolean; } | (): ChannelMuteStatus |
Channel.removeVote | (messageId: string, pollId: string, voteId: string): Promise<APIResponse & { vote: PollVote; }> | (pathParams: { message_id: string; poll_id: string; vote_id: string; }, _request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollVoteResponse>> |
Channel.sendAction | (messageID: string, formData: Record<string, string>): Promise<SendMessageAPIResponse> | (messageId: string, formData: Record<string, string>, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<MessageActionResponse>> |
Channel.stopTyping | (parent_id?: string | undefined, options?: { user_id: string; } | undefined): Promise<void> | (parentId?: string | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<void> |
Channel.constructor | (client: StreamChat, type: string, id: string | undefined, data: ChannelData): Channel | (client: StreamChat, type: string, id: string | undefined, data: ChannelInput): Channel |
Channel.countUnread | (lastRead?: Date | null | undefined): number | (lastRead?: TimestampNS | null | undefined): number |
Channel.createDraft | (message: DraftMessagePayload): Promise<CreateDraftResponse> | (request: CreateDraftRequest, requestOptions?: StreamRequestOptions | undefined): Promise<CreateDraftResponse & { metadata: RequestMetadata; }> |
Channel.deleteDraft | (options?: { parent_id?: string | undefined; } | undefined): Promise<APIResponse> | (request?: { parent_id?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<Response & { metadata: RequestMetadata; }> |
Channel.deleteImage | (url: string): Promise<APIResponse> | (request: { url: string; }, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
Channel.sendMessage | (message: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefined; poll_id?: str… | (request: SendMessageRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<SendMessageResponse>> |
Channel._createDraft | (message: DraftMessagePayload): Promise<CreateDraftResponse> | (request: CreateDraftRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<CreateDraftResponse>> |
Channel._deleteDraft | ({ parent_id }?: { parent_id?: string | undefined; } | undefined): Promise<APIResponse> | (request?: { parent_id?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
Channel.acceptInvite | (options?: Partial<{ accept_invite: boolean; add_members: string[]; add_moderators: string[]; client_id: string; connection_id: string; data: Omit<ChannelResponse, "id" | "cid">; demote_moderators: string[]; invites: string[]; message: Partial<CustomMessageData & { id: string; attachments?: Attachme… | (options?: UpdateChannelRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.queryMembers | (filterConditions: MemberFilters, sort?: MemberSort | undefined, options?: QueryMembersOptions | undefined, requestOptions?: RequestOptions | undefined): Promise<ChannelMemberAPIResponse> | (request?: { payload?: Partial<QueryMembersPayload> | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<MembersResponse>> |
Channel.rejectInvite | (options?: Partial<{ accept_invite: boolean; add_members: string[]; add_moderators: string[]; client_id: string; connection_id: string; data: Omit<ChannelResponse, "id" | "cid">; demote_moderators: string[]; invites: string[]; message: Partial<CustomMessageData & { id: string; attachments?: Attachme… | (options?: UpdateChannelRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.sendReaction | (messageID: string, reaction: Reaction, options?: SendReactionOptions | undefined): Promise<ReactionAPIResponse> | (pathParams: { id: string; }, request: SendReactionRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<SendReactionResponse>> |
Channel.stopWatching | (): Promise<APIResponse> | (request?: (ChannelStopWatchingRequest & { connection_id?: string | undefined; }) | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
Channel.addFilterTags | (tags: string[], message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefin… | ({ tags, ...options }: FilterTagsRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.inviteMembers | (members: string[] | Required<Omit<NewMemberPayload, "channel_role">>[], message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: … | ({ members, ...options }: InviteMembersRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.removeMembers | (members: string[], message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | unde… | ({ members, ...options }: RemoveMembersRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.updateAIState | (messageId: string, state: AIState, options?: { ai_message?: string | undefined; } | undefined): Promise<void> | (messageId: string, state: AIState, options?: { ai_message?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<void> |
Channel.updatePartial | (update: PartialUpdateChannel): Promise<PartialUpdateChannelAPIResponse> | (update: UpdateChannelPartialRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelPartialResponse>> |
Channel.deleteReaction | (messageID: string, reactionType: string, user_id?: string | undefined): Promise<ReactionAPIResponse> | (pathParams: { id: string; type: string; }, _request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<DeleteReactionResponse>> |
Channel.enableSlowMode | (coolDownInterval: number): Promise<UpdateChannelAPIResponse> | (coolDownInterval: number, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.stopAIResponse | (): Promise<void> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<void> |
Channel.disableSlowMode | (): Promise<UpdateChannelAPIResponse> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.getMessagesById | (messageIds: string[]): Promise<GetMultipleMessagesAPIResponse> | (messageIds: string[], requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<GetManyMessagesResponse>> |
Channel.markReadLocally | (): Event | undefined | (): ({ type: "message.read_locally"; } & { channel_type: string; cid: string; created_at: TimestampNS; channel_id?: string | undefined; last_read_message_id?: string | undefined; team?: string | undefined; user?: UserResponse | undefined; } & { received_at?: TimestampNS | undefined; }) | undefined |
Channel._initializeState | (state: ChannelAPIResponse, messageSetToAddToIfDoesNotExist?: MessageSetType | undefined, isNewestPage?: boolean | undefined): { messageSet: MessageSet; filteredMessageIds: string[]; } | (state: ChannelStateResponseFields): void |
Channel.clearAIIndicator | (): Promise<void> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<void> |
Channel.push_preferences | ChannelPushPreference | undefined | ChannelPushPreferencesResponse | undefined |
Channel.removeFilterTags | (tags: string[], message?: Partial<CustomMessageData & { id: string; attachments?: Attachment[] | undefined; html?: string | undefined; mml?: string | undefined; parent_id?: string | undefined; pin_expires?: string | null | undefined; pinned?: boolean | undefined; pinned_at?: string | null | undefin… | ({ tags, ...options }: FilterTagsRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateChannelResponse>> |
Channel.getPinnedMessages | (options: PinnedMessagePaginationOptions & { user?: UserResponse | undefined; user_id?: string | undefined; }, sort?: PinnedMessagesSort | undefined): Promise<GetRepliesAPIResponse> | (request?: { limit?: number | undefined; offset?: number | undefined; id_gte?: string | undefined; id_gt?: string | undefined; id_lte?: string | undefined; id_lt?: string | undefined; pinned_at_after_or_equal?: Date | undefined; pinned_at_after?: Date | undefined; pinned_at_before_or_equal?: Date | … |
Channel.sendSharedLocation | (location: StaticLocationPayload | LiveLocationPayload, userId?: string | undefined): Promise<SendMessageAPIResponse> | (location: SharedLocation & { message_id?: string | undefined; }): Promise<SendMessageResponse & { metadata: RequestMetadata; }> |
Channel.updateMemberPartial | (updates: PartialUpdateMember, options?: { userId?: string | undefined; } | undefined): Promise<PartialUpdateMemberAPIResponse> | (request?: UpdateMemberPartialRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateMemberPartialResponse>> |
Channel.stopLiveLocationSharing | (payload: UpdateLocationPayload): Promise<void> | (payload: UpdateLiveLocationRequest, requestOptions?: StreamRequestOptions | undefined): Promise<void> |
Channel._extendEventWithOwnReactions | (event: Event): void | (event: EventPayload<"message.deleted" | "message.undeleted" | "message.updated">): void |
Reminder.remindAt | Date | null | TimestampNS | null |
Reminder.setState | (data: ReminderResponseBaseOrResponse): void | (data: ReminderResponseData): void |
Reminder.static toStateValue | (data: ReminderResponseBaseOrResponse): ReminderState | (data: ReminderResponseData): ReminderState |
Moderation.flag | (entityType: string, entityId: string, entityCreatorID: string, reason: string, options?: ModerationFlagOptions | undefined): Promise<{ item_id: string; } & APIResponse> | (request: FlagRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<FlagItemResponse>> |
Moderation.flagUser | (flaggedUserID: string, reason: string, options?: ModerationFlagOptions | undefined): Promise<{ item_id: string; } & APIResponse> | ({ user_id, reason, ...options }: { user_id: string; reason?: string | undefined; } & ModerationFlagOptions, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<FlagItemResponse>> |
Moderation.getConfig | (key: string, data?: { team?: string | undefined; } | undefined): Promise<GetConfigResponse> | (pathParams: { key: string; }, request?: { team?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<GetConfigResponse>> |
Moderation.unmuteUser | (targetID: string, options: { user_id?: string | undefined; }): Promise<UnmuteUserResponse> | (targetId: string, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UnmuteResponse>> |
Moderation.flagMessage | (messageID: string, reason: string, options?: ModerationFlagOptions | undefined): Promise<{ item_id: string; } & APIResponse> | ({ message_id, reason, ...options }: { message_id: string; reason?: string | undefined; } & ModerationFlagOptions, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<FlagItemResponse>> |
Moderation.deleteConfig | (key: string, data?: { team?: string | undefined; } | undefined): Promise<APIResponse> | (pathParams: { key: string; }, request?: { team?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<DeleteModerationConfigResponse>> |
Moderation.submitAction | (actionType: string, itemID: string, options?: SubmitActionOptions | undefined): Promise<SubmitActionResponse> | (request: SubmitActionRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<SubmitActionResponse>> |
Moderation.upsertConfig | (config: ModerationConfig): Promise<UpsertConfigResponse> | (request: UpsertConfigRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpsertConfigResponse>> |
Moderation.queryReviewQueue | (filterConditions?: ReviewQueueFilters | undefined, sort?: ReviewQueueSort | undefined, options?: Pager | undefined): Promise<ReviewQueueResponse> | (request?: QueryReviewQueueRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryReviewQueueResponse>> |
StreamChat.on | (callback: EventHandler): { unsubscribe: () => void; } | (eventType: string, callback: EventHandler): { unsubscribe: () => void; } | (callback: EventHandler): { unsubscribe: () => void; } | <T extends EventType>(eventType: T, callback: EventHandler<T>): { unsubscribe: () => void; } |
StreamChat.off | (callback: EventHandler): void | (eventType: string, callback: EventHandler): void | (callback: EventHandler): void | <T extends EventType>(eventType: T, callback: EventHandler<T>): void |
StreamChat.sync | (channel_cids: string[], last_sync_at: string, options?: SyncOptions | undefined): Promise<SyncResponse> | (request: SyncRequest & { with_inaccessible_cids?: boolean | undefined; watch?: boolean | undefined; connection_id?: string | undefined; }, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<SyncResponse>> |
StreamChat.user | UserResponse | OwnUserResponse | undefined | ClientUser | undefined |
StreamChat._user | UserResponse | OwnUserResponse | undefined | ClientUser | undefined |
StreamChat.search | (filterConditions: ChannelFilters, query: string | MessageFilters, options?: SearchOptions | undefined, requestOptions?: RequestOptions | undefined): Promise<SearchAPIResponse> | (request?: { payload?: SearchPayload | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<SearchResponse>> |
StreamChat.channel | (channelType: string, channelID?: string | null | undefined, custom?: ChannelData | undefined): Channel | (channelType: string, custom?: ChannelData | undefined): Channel | (channelType: string, channelId?: string | null | undefined, custom?: ChannelInput | undefined): Channel | (channelType: string, custom?: ChannelInput | undefined): Channel |
StreamChat.getPoll | (id: string, userId?: string | undefined): Promise<APIResponse & GetPollAPIResponse> | (pathParams: { poll_id: string; }, _request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollResponse>> |
StreamChat.setUser | (user: UserResponse | OwnUserResponse, userTokenOrProvider: TokenOrProvider): Promise<void | ConnectionOpen> | (user: ClientUser, userTokenOrProvider: TokenOrProvider): Promise<void | ConnectionOpen> |
StreamChat._setUser | (user: UserResponse | OwnUserResponse): void | (user: TokenManagerMinimalUser): void |
StreamChat.devToken | (userID: string): string | (userId: string): string |
StreamChat._setToken | (user: UserResponse, userTokenOrProvider: TokenOrProvider): Promise<void> | (user: TokenManagerMinimalUser, userTokenOrProvider: TokenOrProvider): Promise<void> |
StreamChat.blockUser | (blockedUserID: string, user_id?: string | undefined): Promise<BlockUserAPIResponse> | (blockedUserId: string, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<BlockUsersResponse>> |
StreamChat.getThread | (messageId: string, options?: GetThreadOptions | undefined): Promise<Thread> | (pathParams: { message_id: string; }, request?: { watch?: boolean | undefined; connection_id?: string | undefined; reply_limit?: number | undefined; participant_limit?: number | undefined; member_limit?: number | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<S… |
StreamChat.listeners | Record<string, ((event: Event) => void)[]> | Map<EventType, Set<EventHandler>> |
StreamChat.unbanUser | (targetUserID: string, options?: UnBanUserOptions | undefined): Promise<APIResponse> | (targetUserId: string, options?: UnBanUserOptions | undefined): Promise<APIResponse> |
StreamChat.createPoll | (poll: CreatePollData, userId?: string | undefined): Promise<APIResponse & CreatePollAPIResponse> | (request: CreatePollRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollResponse>> |
StreamChat.deletePoll | (id: string, userId?: string | undefined): Promise<APIResponse> | (pathParams: { poll_id: string; }, _request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
StreamChat.getMessage | (messageID: string, options?: GetMessageOptions | undefined): Promise<SendMessageAPIResponse> | (pathParams: { id: string; }, _request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<GetMessageResponse>> |
StreamChat.mutedUsers | Mute[] | UserMuteResponse[] |
StreamChat.pinMessage | (messageOrMessageId: string | { id: string; }, timeoutOrExpirationDate?: string | number | Date | null | undefined, pinnedBy?: string | { id: string; } | undefined, pinnedAt?: string | number | Date | undefined): Promise<UpdateMessageAPIResponse> | ({ id }: { id: string; }, { pin_expires, pinned_at }?: PinMessageOptions | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateMessagePartialResponse>> |
StreamChat.queryPolls | (filter?: QueryPollsFilters | undefined, sort?: PollSort | undefined, options?: Pager | undefined, userId?: string | undefined): Promise<APIResponse & QueryPollsResponse> | (request?: QueryPollsRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryPollsResponse>> |
StreamChat.queryUsers | (filterConditions: UserFilters, sort?: UserSort | undefined, options?: UserOptions | undefined, requestOptions?: RequestOptions | undefined): Promise<APIResponse & { users: UserResponse[]; }> | (request?: { payload?: QueryUsersPayload | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryUsersResponse>> |
StreamChat.updatePoll | (poll: PollData, userId?: string | undefined): Promise<APIResponse & UpdatePollAPIResponse> | (request: UpdatePollRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollResponse>> |
StreamChat.uploadFile | (uri: any, name?: string | undefined, contentType?: string | undefined, user?: UserResponse | undefined, axiosRequestConfig?: any): Promise<SendFileAPIResponse> | (request?: (Omit<FileUploadRequest, "file"> & { file?: FileUploadInput | undefined; }) | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<FileUploadResponse>> |
StreamChat._muteStatus | (cid: string): { muted: boolean; createdAt: Date; expiresAt: Date | null; } | { muted: boolean; createdAt: null; expiresAt: null; } | (cid: string): ChannelMuteStatus |
StreamChat.connectUser | (user: UserResponse | OwnUserResponse, userTokenOrProvider: TokenOrProvider): Promise<void | ConnectionOpen> | (user: ClientUser, userTokenOrProvider: TokenOrProvider): Promise<void | ConnectionOpen> |
StreamChat.constructor | (key: string, options?: any): StreamChat | (key: string, secret?: string | undefined, options?: any): StreamChat | (key: string, config?: DeepPartial<InstanceConfigTree> | undefined): StreamChat |
StreamChat.queryDrafts | (options?: (Pager & { filter?: DraftFilters | undefined; sort?: DraftSort | undefined; user_id?: string | undefined; }) | undefined): Promise<QueryDraftsResponse> | (request?: QueryDraftsRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryDraftsResponse>> |
StreamChat.searchRoles | (options: SearchRolesOptions, requestOptions?: RequestOptions | undefined): Promise<SearchRolesAPIResponse> | (request: { query: string; limit?: number | undefined; name_gt?: string | undefined; role_type?: string | undefined; include_global_roles?: boolean | undefined; }, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<SearchRolesResponse>> |
StreamChat.updateUsers | (users: UserResponse[]): Promise<UpdateUsersAPIResponse> | (request: UpdateUsersRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateUsersResponse>> |
StreamChat.uploadImage | (uri: any, name?: string | undefined, contentType?: string | undefined, user?: UserResponse | undefined, axiosRequestConfig?: any): Promise<SendFileAPIResponse> | (request?: (Omit<ImageUploadRequest, "file"> & { file?: FileUploadInput | undefined; }) | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<ImageUploadResponse>> |
StreamChat.castPollVote | (messageId: string, pollId: string, vote: PollVoteData, userId?: string | undefined): Promise<APIResponse & CastVoteAPIResponse> | (pathParams: { message_id: string; poll_id: string; }, request?: CastPollVoteRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollVoteResponse>> |
StreamChat.getUserGroup | (id: string, options?: GetUserGroupOptions | undefined): Promise<GetUserGroupResponse> | (pathParams: { id: string; }, request?: { team_id?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<GetUserGroupResponse>> |
StreamChat.queryThreads | (options?: QueryThreadsOptions | undefined): Promise<{ threads: Thread[]; next: string | undefined; }> | (request?: (QueryThreadsRequest & { connection_id?: string | undefined; }) | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryThreadsResponse>> |
StreamChat.revokeTokens | (before: string | Date | null): Promise<APIResponse> | (before?: Date | null | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateUsersResponse>> |
StreamChat.setGuestUser | (user: UserResponse): Promise<void | ConnectionOpen> | (user: UserRequest, requestOptions?: StreamRequestOptions | undefined): Promise<void | ConnectionOpen> |
StreamChat.unpinMessage | (messageOrMessageId: string | { id: string; }, userId?: string | { id: string; } | undefined): Promise<UpdateMessageAPIResponse> | ({ id }: { id: string; }, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateMessagePartialResponse>> |
StreamChat.wsConnection | StableWSConnection | null | WSConnection |
StreamChat.deleteMessage | (messageID: string, optionsOrHardDelete?: boolean | DeleteMessageOptions | undefined): Promise<APIResponse & { message: MessageResponse; }> | (pathParams: { id: string; }, request?: { hard?: boolean | undefined; delete_for_me?: boolean | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<DeleteMessageResponse>> |
StreamChat.getPollOption | (pollId: string, optionId: string, userId?: string | undefined): Promise<APIResponse & CreatePollOptionAPIResponse> | (pathParams: { poll_id: string; option_id: string; }, _request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollOptionResponse>> |
StreamChat.queryChannels | (filterConditions: ChannelFilters, sort: ChannelSort, options: ChannelOptions, stateOptions: RequestOptions & { offlineMode?: boolean | undefined; skipInitialization?: string[] | undefined; skipHydration?: boolean | undefined; withResponse?: boolean | undefined; } & { withResponse: true; }): Promise… | (request?: (QueryChannelsRequest & { connection_id?: string | undefined; }) | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryChannelsResponse>> |
StreamChat.updateMessage | (message: LocalMessage | Partial<MessageResponse>, partialUserOrUserId?: string | { id: string; } | undefined, options?: UpdateMessageOptions | undefined): Promise<UpdateMessageAPIResponse> | (pathParams: { id: string; }, request: UpdateMessageRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateMessageResponse>> |
StreamChat.createReminder | ({ messageId, ...options }: CreateReminderOptions): Promise<ReminderAPIResponse> | (pathParams: { message_id: string; }, request?: CreateReminderRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<CreateReminderResponse>> |
StreamChat.deleteChannels | (cids: string[], options?: { hard_delete?: boolean | undefined; } | undefined): Promise<APIResponse & { result: Record<string, string>; } & Partial<TaskResponse>> | (request: DeleteChannelsRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<DeleteChannelsResponse>> |
StreamChat.deleteReminder | (messageId: string, userId?: string | undefined): Promise<APIResponse> | (pathParams: { message_id: string; }, _request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<DeleteReminderResponse>> |
StreamChat.getAppSettings | (): Promise<AppSettingsAPIResponse> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<GetApplicationResponse>> |
StreamChat.listBlockLists | (data?: { team?: string | undefined; } | undefined): Promise<APIResponse & { blocklists: BlockListResponse[]; }> | (request?: { team?: string | undefined; cursor?: string | undefined; limit?: number | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<ListBlockListResponse>> |
StreamChat.queryPollVotes | (pollId: string, filter?: QueryVotesFilters | undefined, sort?: VoteSort | undefined, options?: Pager | undefined, userId?: string | undefined): Promise<APIResponse & PollVotesAPIResponse> | (pathParams: { poll_id: string; }, request?: QueryPollVotesRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollVotesResponse>> |
StreamChat.queryReactions | (messageID: string, filter: ReactionFilters, sort?: ReactionSort | undefined, options?: Pager | undefined): Promise<QueryReactionsAPIResponse> | (pathParams: { id: string; }, request?: QueryReactionsRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryReactionsResponse>> |
StreamChat.queryReminders | ({ filter, sort, ...rest }?: QueryRemindersOptions | undefined): Promise<QueryRemindersResponse> | (request?: QueryRemindersRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryRemindersResponse>> |
StreamChat.updateReminder | ({ messageId, ...options }: CreateReminderOptions): Promise<ReminderAPIResponse> | (pathParams: { message_id: string; }, request?: UpdateReminderRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateReminderResponse>> |
StreamChat.userMuteStatus | (targetID: string): boolean | (targetId: string): boolean |
StreamChat.createBlockList | (blockList: BlockList): Promise<APIResponse> | (request: CreateBlockListRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<CreateBlockListResponse>> |
StreamChat.createUserGroup | (options: CreateUserGroupOptions): Promise<CreateUserGroupResponse> | (request: CreateUserGroupRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<CreateUserGroupResponse>> |
StreamChat.deleteBlockList | (name: string, data?: { team?: string | undefined; } | undefined): Promise<APIResponse> | (pathParams: { name: string; }, request?: { team?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
StreamChat.deleteUserGroup | (id: string, options?: DeleteUserGroupOptions | undefined): Promise<APIResponse> | (pathParams: { id: string; }, request?: { team_id?: string | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
StreamChat.getBlockedUsers | (user_id?: string | undefined): Promise<GetBlockedUsersAPIResponse> | (_request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<GetBlockedUsersResponse>> |
StreamChat.updateBlockList | (name: string, data: { words: string[]; team?: string | undefined; }): Promise<APIResponse> | (pathParams: { name: string; }, request?: UpdateBlockListRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateBlockListResponse>> |
StreamChat.updateUserGroup | (id: string, options: UpdateUserGroupOptions): Promise<UpdateUserGroupResponse> | (pathParams: { id: string; }, request?: UpdateUserGroupRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<UpdateUserGroupResponse>> |
StreamChat._handleUserEvent | (event: Event): void | (event: ({ type: "user.deleted"; } & UserDeletedEvent) | ({ type: "user.presence.changed"; } & UserPresenceChangedEvent) | ({ type: "user.updated"; } & UserUpdatedEvent)): void |
StreamChat.createPollOption | (pollId: string, option: PollOptionData, userId?: string | undefined): Promise<APIResponse & CreatePollOptionAPIResponse> | (pathParams: { poll_id: string; }, request: CreatePollOptionRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollOptionResponse>> |
StreamChat.deletePollOption | (pollId: string, optionId: string, userId?: string | undefined): Promise<APIResponse> | (pathParams: { poll_id: string; option_id: string; }, _request?: Record<string, never> | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<Response>> |
StreamChat.markChannelsRead | (data?: MarkChannelsReadOptions | undefined): Promise<void> | (request?: MarkChannelsReadRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<MarkReadResponse>> |
StreamChat.queryBannedUsers | (filterConditions?: BannedUsersFilters | undefined, sort?: BannedUsersSort | undefined, options?: BannedUsersPaginationOptions | undefined): Promise<BannedUsersResponse> | (request?: { payload?: QueryBannedUsersPayload | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryBannedUsersResponse>> |
StreamChat.queryPollAnswers | (pollId: string, filter?: QueryVotesFilters | undefined, sort?: VoteSort | undefined, options?: Pager | undefined, userId?: string | undefined): Promise<APIResponse & PollAnswersAPIResponse> | (pathParams: { poll_id: string; }, request?: QueryPollVotesRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollVotesResponse>> |
StreamChat.searchUserGroups | (options: SearchUserGroupsOptions, requestOptions?: RequestOptions | undefined): Promise<SearchUserGroupsResponse> | (request: { query: string; limit?: number | undefined; name_gt?: string | undefined; id_gt?: string | undefined; team_id?: string | undefined; }, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<SearchUserGroupsResponse>> |
StreamChat.translateMessage | (messageId: string, language: string): Promise<APIResponse & { message: MessageResponse; }> | (pathParams: { id: string; }, request: TranslateMessageRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<TranslateMessageResponse>> |
StreamChat.updatePollOption | (pollId: string, option: PollOptionData, userId?: string | undefined): Promise<APIResponse & CreatePollOptionAPIResponse> | (pathParams: { poll_id: string; }, request: UpdatePollOptionRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<PollOptionResponse>> |
StreamChat._addChannelConfig | ({ cid, config }: ChannelResponse): void | ({ cid, config }: Pick<ChannelResponse, "cid" | "config">): void |
StreamChat.queryMessageFlags | (filterConditions?: MessageFlagsFilters | undefined, options?: MessageFlagsPaginationOptions | undefined): Promise<MessageFlagsResponse> | (request?: { payload?: QueryMessageFlagsPayload | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryMessageFlagsResponse>> |
StreamChat._handleClientEvent | (event: Event): (() => void)[] | (event: WSEvent): (() => void)[] |
StreamChat.appSettingsPromise | Promise<AppSettingsAPIResponse> | undefined | Promise<StreamResponse<GetApplicationResponse>> | undefined |
StreamChat.addUserGroupMembers | (id: string, options: AddUserGroupMembersOptions): Promise<AddUserGroupMembersResponse> | (pathParams: { id: string; }, request: AddUserGroupMembersRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<AddUserGroupMembersResponse>> |
StreamChat.cleaningIntervalRef | any | number | undefined |
StreamChat._updateUserReferences | (user: UserResponse): void | (user: UserResponse, { readEntries }?: { readEntries?: boolean | undefined; } | undefined): void |
StreamChat.queryFutureChannelBans | (options?: QueryFutureChannelBansOptions | undefined): Promise<FutureChannelBansResponse> | (request?: { payload?: QueryFutureChannelBansPayload | undefined; } | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<QueryFutureChannelBansResponse>> |
StreamChat.removeUserGroupMembers | (id: string, options: RemoveUserGroupMembersOptions): Promise<RemoveUserGroupMembersResponse> | (pathParams: { id: string; }, request: RemoveUserGroupMembersRequest, requestOptions?: StreamRequestOptions | undefined): Promise<StreamResponse<RemoveUserGroupMembersResponse>> |
StreamChat._deleteUserMessageReference | (user: UserResponse, hardDelete?: boolean | undefined, deletedAt?: Date | null | undefined): void | (user: UserResponse, hardDelete?: boolean | undefined, deletedAt?: TimestampNS | undefined): void |
StreamChat._updateMemberWatcherReferences | (user: UserResponse): void | (user: UserResponse, { readEntries }?: { readEntries?: boolean | undefined; } | undefined): void |
StreamChat.setMessageComposerSetupFunction | (setupFunction: MessageComposerSetupFunction | null): void | (setupFunction: InstanceSetupFunction<"messageComposer"> | null): void |
ClientState.users | { [key: string]: UserResponse; } | { [key: string]: UserResponse | OwnUserResponse; } |
ClientState.updateUser | (user?: UserResponse | undefined): void | (user?: UserResponse | OwnUserResponse | undefined): void |
PollManager.createPoll | (poll: CreatePollData): Promise<Poll | undefined> | (poll: CreatePollRequest): Promise<Poll | undefined> |
PollManager.queryPolls | (filter: QueryPollsFilters, sort?: PollSort | undefined, options?: Pager | undefined): Promise<{ polls: (Poll | undefined)[]; next: string | undefined; }> | (request?: QueryPollsRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<{ polls: (Poll | undefined)[]; next: string | undefined; }> |
ChannelState.typing | Record<string, Event> | Record<string, { type: "typing.start"; } & TypingStartEvent & { received_at?: TimestampNS | undefined; }> |
ChannelState.formatMessage | (message: MessageResponseBase | MessageResponse | LocalMessage): LocalMessage | (message: MessageResponse | LocalMessage): LocalMessage |
OfflineDBApi.getChannels | (options: DBGetChannelsType): Promise<Omit<ChannelAPIResponse, "duration">[] | null> | (options: DBGetChannelsType): Promise<Omit<ChannelStateResponseFields, "duration">[] | null> |
OfflineDBApi.getAppSettings | (options: DBGetAppSettingsType): Promise<AppSettingsAPIResponse | null> | (options: DBGetAppSettingsType): Promise<GetApplicationResponse | null> |
OfflineDBApi.getChannelsForQuery | (options: DBGetChannelsForQueryType): Promise<Omit<ChannelAPIResponse, "duration">[] | null> | (options: DBGetChannelsForQueryType): Promise<DBGetChannelsForQueryResult | null> |
PollComposer.updateFields | (data: UpdateFieldsData, injectedFieldErrors?: Partial<Omit<Record<"id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility", string>, "options"> & { options?: Record<stri… | ({ data, injectedFieldErrors, }: { data: UpdateFieldsData; injectedFieldErrors?: Partial<Omit<Record<keyof CreatePollRequest, PollComposerValidationError>, "options"> & { options?: Record<string, PollComposerValidationError> | undefined; }> | undefined; }): Promise<void> |
PollComposer.handleFieldBlur | (field: "id" | "user_id" | "name" | "description" | "allow_answers" | "allow_user_suggested_options" | "enforce_unique_vote" | "is_closed" | "max_votes_allowed" | "options" | "voting_visibility"): Promise<void> | (field: "id" | "name" | "options" | "max_votes_allowed" | "allow_answers" | "allow_user_suggested_options" | "description" | "enforce_unique_vote" | "is_closed" | "voting_visibility"): Promise<void> |
TextComposer.command | CommandResponse | null | undefined | Command | null | undefined |
TextComposer.setCommand | (command: CommandResponse | null): void | (command: Command | null): void |
TextComposer.getMentionEntity | (mentionType: "user" | "channel" | "role" | "here" | "user_group", id: string): MentionEntity | undefined | (mentionType: "channel" | "user" | "user_group" | "role" | "here", id: string): MentionEntity | undefined |
TextComposer.removeMentionEntity | (mentionType: "user" | "channel" | "role" | "here" | "user_group", id: string): void | (mentionType: "channel" | "user" | "user_group" | "role" | "here", id: string): void |
TokenManager.user | UserResponse | undefined | TokenManagerMinimalUser | undefined |
TokenManager.getToken | (): string | undefined | (): string |
TokenManager.constructor | (secret?: any): TokenManager | (): TokenManager |
TokenManager.validateToken | (tokenOrProvider: TokenOrProvider, user: UserResponse): void | (tokenOrProvider: TokenOrProvider, user: TokenManagerMinimalUser): void |
TokenManager.setTokenOrProvider | (tokenOrProvider: TokenOrProvider, user: UserResponse): Promise<void> | (tokenOrProvider: TokenOrProvider, user: TokenManagerMinimalUser): Promise<void> |
BasePaginator.cursor | Cursor | undefined | PaginatorCursor | undefined |
BasePaginator.constructor | <T>(options?: PaginatorOptions | undefined): BasePaginator<T> | <T, Q, R = PaginationQueryReturnValue<T>>({ declarativeConfig, initialCursor, initialOffset, itemIndex, createItemIndex, ...options }?: PaginatorOptions<T, Q> | undefined, builtInDefaults?: Partial<BasePaginatorConfig<T, Q>> | undefined): BasePaginator<T, Q, R> |
BasePaginator.executeQuery | ({ direction }: { direction: PaginationDirection; }): Promise<void> | (params?: PaginationQueryParams<Q> | undefined): Promise<void | ExecuteQueryReturnValue<T>> |
BasePaginator.initialState | PaginatorState<any> | PaginatorState<T> |
BasePaginator.canExecuteQuery | (direction: PaginationDirection): boolean | ({ direction, reset, }: { direction?: PaginationDirection | undefined; } & Pick<PaginationQueryParams<Q>, "reset">): boolean |
BasePaginator.filterQueryResults | (items: T[]): T[] | Promise<T[]> | (items: T[]): T[] |
BasePaginator.getStateAfterQuery | (stateUpdate: Partial<PaginatorState<T>>, isFirstPage: boolean): PaginatorState<T> | (stateUpdate: Partial<PaginatorState<T>>, _isFirstPage: boolean): PaginatorState<T> |
BasePaginator._executeQueryDebounced | (params: { direction: PaginationDirection; }): Promise<void> | undefined | (params: PaginationQueryParams<Q>): Promise<void> | undefined |
UploadManager.upload | ({ id, channelCid, file, }: { id: string; channelCid: string; file: FileReference | FileLike; }): Promise<MinimumUploadRequestResult | { blocklist?: BlockListResponse | undefined; file: string; thumb_url?: string | undefined; }> | ({ id, channelCid, file, }: { id: string; channelCid: string; file: FileReference | FileLike; }): Promise<MinimumUploadRequestResult> |
ChannelManager.client | any | StreamChat |
ChannelManager.constructor | ({ client, eventHandlerOverrides, options, queryChannelsOverride, }: { client: StreamChat; eventHandlerOverrides?: Partial<Record<ChannelManagerEventHandlerNames, EventHandlerOverrideType>> | undefined; options?: ChannelManagerOptions | undefined; queryChannelsOverride?: QueryChannelsRequestType | u… | ({ client, eventHandlers, paginators, ownershipResolver, }: ChannelManagerOptions): ChannelManager |
ChannelManager.registerSubscriptions | (): void | (): Unsubscribe |
ThreadResponse.channel | ChannelResponse | ChannelResponse | undefined |
ThreadResponse.created_at | string | TimestampNS |
ThreadResponse.deleted_at | string | undefined | TimestampNS | undefined |
ThreadResponse.updated_at | string | TimestampNS |
ThreadResponse.reply_count | number | undefined | number |
ThreadResponse.parent_message | MessageResponse | MessageResponse | undefined |
ThreadResponse.last_message_at | string | undefined | TimestampNS | undefined |
ThreadResponse.participant_count | number | undefined | number |
ThreadResponse.thread_participants | { channel_cid: string; created_at: string; last_read_at: string; last_thread_message_at?: string | undefined; left_thread_at?: string | undefined; thread_id?: string | undefined; user?: UserResponse | undefined; user_id?: string | undefined; }[] | undefined | ThreadParticipant[] | undefined |
ThreadResponse.active_participant_count | number | undefined | number |
MessageComposer.tag | `message_${string}` | `channel_${string}` | `thread_${string}` | `legacy_thread_${string}` | `message_${string}` | `channel_${string}` | `thread_${string}` |
MessageComposer.config | MessageComposerConfig | Readonly<MessageComposerConfig> |
MessageComposer.contextType | "channel" | "message" | "thread" | "legacy_thread" | "channel" | "thread" | "message" |
MessageComposer.quotedMessage | LocalMessageBase | null | LocalMessage | null |
MessageComposer.isCommandDisabled | (command: CommandResponse): boolean | (command: Command): boolean |
MessageComposer.static constructTag | (compositionContext: CompositionContext): `message_${string}` | `channel_${string}` | `thread_${string}` | `legacy_thread_${string}` | (compositionContext: CompositionContext): `message_${string}` | `channel_${string}` | `thread_${string}` |
MessageComposer.getCommandDisabledReason | (command: CommandResponse): CommandSuggestionDisabledReason | undefined | (command: Command): CommandSuggestionDisabledReason | undefined |
MessageComposer.static evaluateContextType | (compositionContext: CompositionContext): "channel" | "message" | "thread" | "legacy_thread" | (compositionContext: CompositionContext): "channel" | "thread" | "message" |
MessageComposer.validateCommandSendability | (command: CommandResponse, text?: string | undefined): CommandSendability | (command: Command, text?: string | undefined): CommandSendability |
MessageComposer.initStateFromChannelResponse | (channelApiResponse: ChannelAPIResponse): void | (channelApiResponse: ChannelStateResponseFields): void |
ReminderManager.upsertToState | ({ data, overwrite, }: { data: ReminderResponseBaseOrResponse; overwrite?: boolean | undefined; }): Reminder | undefined | ({ data, overwrite, }: { data: ReminderResponseData; overwrite?: boolean | undefined; }): Reminder | undefined |
ReminderManager.createReminder | (options: CreateReminderOptions): Promise<Reminder | undefined> | (pathParams: { message_id: string; }, request?: CreateReminderRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<Reminder | undefined> |
ReminderManager.updateReminder | (options: CreateReminderOptions): Promise<Reminder | undefined> | (pathParams: { message_id: string; }, request?: UpdateReminderRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<Reminder | undefined> |
ReminderManager.upsertReminder | (options: CreateReminderOptions): Promise<Reminder | undefined> | (pathParams: { message_id: string; }, request?: CreateReminderRequest | undefined, requestOptions?: StreamRequestOptions | undefined): Promise<Reminder | undefined> |
LocationComposer.location | StaticLocationPayload | LiveLocationPreview | null | StaticLocationPreview | LiveLocationPreview | null |
LocationComposer.validLocation | StaticLocationPayload | LiveLocationPayload | null | StaticLocationPreview | null |
SearchController.config | SearchControllerConfig | Readonly<SearchControllerConfig> |
SearchController.constructor | ({ config, sources }?: SearchControllerOptions | undefined): SearchController | ({ client, config, sources }?: SearchControllerOptions | undefined): SearchController |
UserSearchSource.sort | UserSort | undefined | SortParamRequest[] | undefined |
UserSearchSource.query | (searchQuery: string, queryOptions?: SearchQueryOptions | undefined): Promise<{ items: UserResponse[]; }> | (searchQuery: string, queryOptions?: SearchQueryOptions | undefined): Promise<{ items: FullUserResponse[]; }> |
UserSearchSource.state | StateStore<SearchSourceState<UserResponse>> | StateStore<SearchSourceState<T>> |
UserSearchSource.filters | UserFilters | undefined | Filters<{ banned: { type: boolean; operators: "$eq" | "$ne"; }; bypass_moderation: { type: boolean; operators: "$eq" | "$ne"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomUserData; operators: "$contains" | "$eq… |
UserSearchSource.constructor | <TFilterContext extends CustomContext = CustomContext>(client: StreamChat, options?: UserSearchSourceOptions | undefined, filterBuilderOptions?: FilterBuilderOptions<UserFilters, UserSearchSourceFilterBuilderContext<TFilterContext>> | undefined): UserSearchSource<TFilterContext> | <TFilterContext extends CustomContext = CustomContext>(client: StreamChat, options?: UserSearchSourceOptions | undefined, filterBuilderOptions?: FilterBuilderOptions<Filters<{ banned: { type: boolean; operators: "$eq" | "$ne"; }; bypass_moderation: { type: boolean; operators: "$eq" | "$ne"; }; creat… |
UserSearchSource.filterBuilder | FilterBuilder<UserFilters, UserSearchSourceFilterBuilderContext<TFilterContext>> | FilterBuilder<Filters<{ banned: { type: boolean; operators: "$eq" | "$ne"; }; bypass_moderation: { type: boolean; operators: "$eq" | "$ne"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomUserData; operators: "$co… |
AbstractOfflineDB.handleRead | ({ event, unreadMessages, execute, }: { event: Event; unreadMessages?: number | undefined; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> | ({ event, unreadMessages, execute, }: { event: EventPayload<"message.read" | "notification.mark_read" | "notification.mark_unread" | "message.read_locally">; unreadMessages?: number | undefined; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> |
AbstractOfflineDB.getChannels | (options: DBGetChannelsType): Promise<Omit<ChannelAPIResponse, "duration">[] | null> | (options: DBGetChannelsType): Promise<Omit<ChannelStateResponseFields, "duration">[] | null> |
AbstractOfflineDB.getAppSettings | (options: DBGetAppSettingsType): Promise<AppSettingsAPIResponse | null> | (options: DBGetAppSettingsType): Promise<GetApplicationResponse | null> |
AbstractOfflineDB.handleDraftEvent | ({ event, execute, }: { event: Event; execute?: boolean | undefined; }): Promise<ExecuteBatchDBQueriesType> | ({ event, execute, }: { event: EventPayload<`draft.${string}`>; execute?: boolean | undefined; }): Promise<ExecuteBatchDBQueriesType> |
AbstractOfflineDB.handleNewMessage | ({ event, execute, }: { event: Event; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> | ({ event, execute, }: { event: { type: "message.new"; } & MessageNewEvent & { received_at?: TimestampNS | undefined; }; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> |
AbstractOfflineDB.handleMemberEvent | ({ event, execute, }: { event: Event; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> | ({ event, execute, }: { event: EventPayload<`member.${string}`>; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> |
AbstractOfflineDB.getChannelsForQuery | (options: DBGetChannelsForQueryType): Promise<Omit<ChannelAPIResponse, "duration">[] | null> | (options: DBGetChannelsForQueryType): Promise<DBGetChannelsForQueryResult | null> |
AbstractOfflineDB.handleDeleteMessage | ({ event, execute, }: { event: Event; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> | ({ event, execute, }: { event: { type: "message.deleted"; } & MessageDeletedEvent & { received_at?: TimestampNS | undefined; }; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> |
AbstractOfflineDB.handleReactionEvent | ({ event, execute, }: { event: Event; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> | ({ event, execute, }: { event: EventPayload<`reaction.${string}`>; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> |
AbstractOfflineDB.queriesWithChannelGuard | ({ event, execute, forceUpdate, }: { event: Event; execute?: boolean | undefined; forceUpdate?: boolean | undefined; }, createQueries: (executeOverride?: boolean | undefined) => Promise<PrepareBatchDBQueries[]>): Promise<PrepareBatchDBQueries[]> | ({ event, execute, forceUpdate, }: { event: ({ type: "ai_indicator.clear"; } & AIIndicatorClearEvent & { received_at?: TimestampNS | undefined; }) | ({ type: "ai_indicator.stop"; } & AIIndicatorStopEvent & { received_at?: TimestampNS | undefined; }) | ({ type: "ai_indicator.update"; } & AIIndicatorU… |
AbstractOfflineDB.handleMessageUpdatedEvent | ({ event, execute, }: { event: Event; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> | ({ event, execute, }: { event: EventPayload<"message.undeleted" | "message.updated">; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> |
AbstractOfflineDB.handleChannelTruncatedEvent | ({ event, execute, }: { event: Event; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> | ({ event, execute, }: { event: { type: "channel.truncated"; } & ChannelTruncatedEvent & { received_at?: TimestampNS | undefined; }; execute?: boolean | undefined; }): Promise<PrepareBatchDBQueries[]> |
AbstractOfflineDB.handleChannelVisibilityEvent | ({ event, execute, }: { event: Event; execute?: boolean | undefined; }): Promise<ExecuteBatchDBQueriesType> | ({ event, execute, }: { event: EventPayload<"channel.hidden" | "channel.visible">; execute?: boolean | undefined; }): Promise<ExecuteBatchDBQueriesType> |
AttachmentManager.uploadFile | (file: FileReference | FileLike): Promise<LocalUploadAttachment> | (fileOrAttachment: LocalUploadAttachment | FileReference | FileLike): Promise<LocalUploadAttachment> |
AttachmentManager.doUploadRequest | (fileLike: FileReference | FileLike, options?: UploadRequestOptions | undefined): Promise<MinimumUploadRequestResult | { blocklist?: BlockListResponse | undefined; file: string; thumb_url?: string | undefined; }> | (fileLike: FileReference | FileLike, options?: UploadRequestOptions | undefined): Promise<MinimumUploadRequestResult> |
AttachmentManager.upsertAttachments | (attachmentsToUpsert: LocalAttachment[]): void | (attachmentsToUpsert: (Attachment | LocalAttachment)[]): void |
AttachmentManager.doDefaultUploadRequest | (fileLike: FileReference | FileLike, options?: UploadRequestOptions | undefined): Promise<{ blocklist?: BlockListResponse | undefined; file: string; thumb_url?: string | undefined; }> | (fileLike: FileReference | FileLike, options?: UploadRequestOptions | undefined): Promise<MinimumUploadRequestResult> |
ReminderPaginator.sort | ReminderSort | undefined | SortParamRequest[] | undefined |
ReminderPaginator._sort | ReminderSort | undefined | SortParamRequest[] | undefined |
ReminderPaginator.items | ReminderResponse[] | undefined | ReminderResponseData[] | undefined |
ReminderPaginator.state | StateStore<PaginatorState<ReminderResponse>> | StateStore<PaginatorState<T>> |
ReminderPaginator.cursor | Cursor | undefined | PaginatorCursor | undefined |
ReminderPaginator.filters | ReminderFilters | undefined | ({ channel_cid?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $gt: string | Date; $gte: string | Date; $lt: string | Date; $lte: string | Date; }, "$eq" | "$gt" | "$gte" | "… |
ReminderPaginator._filters | ReminderFilters | undefined | ({ channel_cid?: string | RequireOnlyOne<{ $eq: string | null; $in: string[]; }, "$eq" | "$in"> | null | undefined; created_at?: string | Date | RequireOnlyOne<{ $eq: string | Date | null; $gt: string | Date; $gte: string | Date; $lt: string | Date; $lte: string | Date; }, "$eq" | "$gt" | "$gte" | "… |
ReminderPaginator.constructor | (client: StreamChat, options?: PaginatorOptions | undefined): ReminderPaginator | (client: StreamChat, options?: PaginatorOptions<ReminderResponseData, QueryRemindersRequest> | undefined): ReminderPaginator |
ReminderPaginator.executeQuery | ({ direction }: { direction: PaginationDirection; }): Promise<void> | (params?: PaginationQueryParams<QueryRemindersRequest> | undefined): Promise<void | ExecuteQueryReturnValue<ReminderResponseData>> |
ReminderPaginator.initialState | PaginatorState<any> | PaginatorState<ReminderResponseData> |
ReminderPaginator.canExecuteQuery | (direction: PaginationDirection): boolean | ({ direction, reset, }: { direction?: PaginationDirection | undefined; } & Pick<PaginationQueryParams<QueryRemindersRequest>, "reset">): boolean |
ReminderPaginator.filterQueryResults | (items: ReminderResponse[]): ReminderResponse[] | (items: ReminderResponseData[]): ReminderResponseData[] |
ReminderPaginator.getStateAfterQuery | (stateUpdate: Partial<PaginatorState<ReminderResponse>>, isFirstPage: boolean): PaginatorState<ReminderResponse> | (stateUpdate: Partial<PaginatorState<ReminderResponseData>>, _isFirstPage: boolean): PaginatorState<ReminderResponseData> |
ReminderPaginator._executeQueryDebounced | (params: { direction: PaginationDirection; }): Promise<void> | undefined | (params: PaginationQueryParams<QueryRemindersRequest>): Promise<void> | undefined |
ReminderPaginator.getStateBeforeFirstQuery | (): PaginatorState<ReminderResponse> | (): PaginatorState<ReminderResponseData> |
StableWSConnection.ws | any | WebSocket | undefined |
StableWSConnection.onopen | (wsID: number): void | (wsId: number, authMessage: string): void |
StableWSConnection.onclose | (wsID: number, event: WebSocket.CloseEvent): void | (wsId: number, event: CloseEvent): void |
StableWSConnection.onerror | (wsID: number, event: WebSocket.ErrorEvent): void | (wsId: number, event: Event): void |
StableWSConnection.onmessage | (wsID: number, event: WebSocket.MessageEvent): void | (wsId: number, event: MessageEvent<any>): void |
StableWSConnection.constructor | ({ client }: { client: StreamChat; }): StableWSConnection | ({ wsConnection }: { wsConnection: WSConnection; }): StableWSConnection |
StableWSConnection._errorFromWSEvent | (event: any, isWSFailure?: boolean | undefined): Error & { code?: string | number | undefined; isWSFailure?: boolean | undefined; StatusCode?: string | number | undefined; } | (event: Event | MessageEvent<any> | CloseEvent | ErrorEvent, isWSFailure?: boolean | undefined): Error & { code?: string | number | undefined; isWSFailure?: boolean | undefined; StatusCode?: string | number | undefined; } |
StableWSConnection.healthCheckTimeoutRef | any | number | undefined |
StableWSConnection.connectionCheckTimeoutRef | any | number | undefined |
UserGroupPaginator.state | StateStore<PaginatorState<UserGroupResponse>> | StateStore<PaginatorState<T>> |
UserGroupPaginator.cursor | Cursor | undefined | PaginatorCursor | undefined |
UserGroupPaginator.constructor | (client: StreamChat, options?: PaginatorOptions | undefined): UserGroupPaginator | (client: StreamChat, options?: PaginatorOptions<UserGroupResponse, { limit?: number | undefined; id_gt?: string | undefined; created_at_gt?: string | undefined; team_id?: string | undefined; }> | undefined): UserGroupPaginator |
UserGroupPaginator.executeQuery | ({ direction }: { direction: PaginationDirection; }): Promise<void> | (params?: PaginationQueryParams<{ limit?: number | undefined; id_gt?: string | undefined; created_at_gt?: string | undefined; team_id?: string | undefined; }> | undefined): Promise<void | ExecuteQueryReturnValue<UserGroupResponse>> |
UserGroupPaginator.canExecuteQuery | (direction: PaginationDirection): boolean | ({ direction, reset, }: { direction?: PaginationDirection | undefined; } & Pick<PaginationQueryParams<{ limit?: number | undefined; id_gt?: string | undefined; created_at_gt?: string | undefined; team_id?: string | undefined; }>, "reset">): boolean |
UserGroupPaginator.getStateAfterQuery | (stateUpdate: Partial<PaginatorState<UserGroupResponse>>, isFirstPage: boolean): PaginatorState<UserGroupResponse> | (stateUpdate: Partial<PaginatorState<UserGroupResponse>>, _isFirstPage: boolean): PaginatorState<UserGroupResponse> |
UserGroupPaginator._executeQueryDebounced | (params: { direction: PaginationDirection; }): Promise<void> | undefined | (params: PaginationQueryParams<{ limit?: number | undefined; id_gt?: string | undefined; created_at_gt?: string | undefined; team_id?: string | undefined; }>): Promise<void> | undefined |
ChannelSearchSource.sort | ChannelSort | undefined | SortParamRequest[] | undefined |
ChannelSearchSource.state | StateStore<SearchSourceState<Channel>> | StateStore<SearchSourceState<T>> |
ChannelSearchSource.filters | ChannelFilters | undefined | ({ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean … |
ChannelSearchSource.constructor | <TFilterContext extends CustomContext = CustomContext>(client: StreamChat, options?: ChannelSearchSourceOptions | undefined, filterBuilderOptions?: FilterBuilderOptions<ChannelFilters, ChannelSearchSourceFilterBuilderContext<TFilterContext>> | undefined): ChannelSearchSource<TFilterContext> | <TFilterContext extends CustomContext = CustomContext>(client: StreamChat, options?: ChannelSearchSourceOptions | undefined, filterBuilderOptions?: FilterBuilderOptions<{ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: st… |
ChannelSearchSource.filterBuilder | FilterBuilder<ChannelFilters, ChannelSearchSourceFilterBuilderContext<TFilterContext>> | FilterBuilder<{ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | numb… |
CommandSearchSource.query | (searchQuery: string): { items: { id: "all" | "giphy" | "ban" | "fun_set" | "moderation_set" | "mute" | "unban" | "unmute"; created_at?: string | undefined; updated_at?: string | undefined; args?: string | undefined; description?: string | undefined; name: "all" | "giphy" | "ban" | "fun_set" | "mode… | (searchQuery: string): { items: { id: string; args: string; description: string; name: string; set: string; created_at?: TimestampNS | undefined; updated_at?: TimestampNS | undefined; }[]; next: null; } |
CommandSearchSource.state | StateStore<SearchSourceState<CommandSuggestion>> | StateStore<SearchSourceState<T>> |
LinkPreviewsManager.static getPreviewData | (preview: LinkPreview): { og_scrape_url: string; asset_url?: string | undefined; author_link?: string | undefined; author_name?: string | undefined; image_url?: string | undefined; text?: string | undefined; thumb_url?: string | undefined; title?: string | undefined; title_link?: string | undefined;… | (preview: LinkPreview): { custom: CustomAttachmentData; type?: string | undefined; text?: string | undefined; giphy?: Images | undefined; actions?: Action[] | undefined; title?: string | undefined; fields?: Field[] | undefined; thumb_url?: string | undefined; asset_url?: string | undefined; author_i… |
MessageSearchSource.query | (searchQuery: string, queryOptions?: SearchQueryOptions | undefined): Promise<{ items: never[]; next?: undefined; } | { items: MessageResponse[]; next: string | undefined; }> | (searchQuery: string, queryOptions?: SearchQueryOptions | undefined): Promise<{ items: never[]; next?: undefined; } | { items: SearchResultMessage[]; next: string | undefined; }> |
MessageSearchSource.state | StateStore<SearchSourceState<MessageResponse>> | StateStore<SearchSourceState<T>> |
MessageSearchSource.constructor | <TContexts extends MessageSearchSourceContexts = {}>(client: StreamChat, options?: MessageSearchSourceOptions | undefined, filterBuilderOptions?: Partial<{ messageSearchChannel: FilterBuilderOptions<ChannelFilters, MergeContext<{ searchQuery?: string | undefined; }, TContexts["messageSearchChannelCo… | <TContexts extends MessageSearchSourceContexts = {}>(client: StreamChat, options?: MessageSearchSourceOptions | undefined, filterBuilderOptions?: Partial<{ messageSearchChannel: FilterBuilderOptions<{ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | nu… |
MessageSearchSource.channelQuerySort | ChannelSort | undefined | SortParamRequest[] | undefined |
MessageSearchSource.messageSearchSort | SearchMessageSort | undefined | SortParamRequest[] | undefined |
MessageSearchSource.channelQueryFilters | ChannelFilters | undefined | ({ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean … |
MessageSearchSource.messageSearchFilters | MessageFilters | undefined | ({ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $eq: string | number | boolean | Date | null; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; $lte: string … |
MessageSearchSource.channelQueryFilterBuilder | FilterBuilder<ChannelFilters, MergeContext<{ cids?: string[] | undefined; }, TContexts["channelQueryContext"]>> | FilterBuilder<{ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $contains: string | number | boolean | Date; $eq: string | number | boolean | Date | null; $exists: boolean; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | numb… |
MessageSearchSource.messageSearchFilterBuilder | FilterBuilder<MessageFilters, MergeContext<{ searchQuery?: string | undefined; }, TContexts["messageSearchContext"]>> | FilterBuilder<{ [x: `custom.${string}`]: string | number | boolean | Date | RequireOnlyOne<{ $eq: string | number | boolean | Date | null; $gt: string | number | boolean | Date; $gte: string | number | boolean | Date; $in: (string | number | boolean | Date)[]; $lt: string | number | boolean | Date; … |
MessageSearchSource.messageSearchChannelFilters | ChannelFilters | undefined | Filters<{ app_banned: { type: string; operators: "$eq"; }; archived: { type: boolean; operators: "$eq"; }; blocked: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type: string; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$… |
MessageSearchSource.messageSearchChannelFilterBuilder | FilterBuilder<ChannelFilters, MergeContext<{ searchQuery?: string | undefined; }, TContexts["messageSearchChannelContext"]>> | FilterBuilder<Filters<{ app_banned: { type: string; operators: "$eq"; }; archived: { type: boolean; operators: "$eq"; }; blocked: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type: string; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in… |
NotificationManager.config | NotificationManagerConfig | Readonly<NotificationManagerConfig> |
MentionsSearchSource.state | StateStore<SearchSourceState<MentionSuggestion>> | StateStore<SearchSourceState<T>> |
MentionsSearchSource.userSort | UserSort | undefined | SortParamRequest[] | undefined |
MentionsSearchSource.memberSort | MemberSort | undefined | SortParamRequest[] | undefined |
MentionsSearchSource.queryUsers | (searchQuery: string, offset?: number | undefined, queryOptions?: SearchQueryOptions | undefined): Promise<UserResponse[]> | (searchQuery: string, offset?: number | undefined, queryOptions?: SearchQueryOptions | undefined): Promise<FullUserResponse[]> |
MentionsSearchSource.userFilters | UserFilters | undefined | Filters<{ banned: { type: boolean; operators: "$eq" | "$ne"; }; bypass_moderation: { type: boolean; operators: "$eq" | "$ne"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomUserData; operators: "$contains" | "$eq… |
MentionsSearchSource.memberFilters | MemberFilters | undefined | Filters<{ banned: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type: string; operators: "$eq"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomMemberData;… |
MentionsSearchSource.isMentionTypeAllowed | (mentionType: "user" | "channel" | "role" | "here" | "user_group"): boolean | (mentionType: "channel" | "user" | "user_group" | "role" | "here"): boolean |
MentionsSearchSource.prepareQueryUsersParams | (searchQuery: string, offset?: number | undefined): { filters: UserFilters; sort: UserSort; options: { limit: number; offset: number; include_deactivated_users?: boolean | undefined; presence?: boolean | undefined; }; } | (searchQuery: string, offset?: number | undefined): { filters: Filters<{ banned: { type: boolean; operators: "$eq" | "$ne"; }; bypass_moderation: { type: boolean; operators: "$eq" | "$ne"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }… |
MentionsSearchSource.prepareQueryMembersParams | (searchQuery: string, offset?: number | undefined): { filters: MemberFilters; sort: MemberSort; options: { limit: number; offset: number; include_deactivated_users?: boolean | undefined; presence?: boolean | undefined; }; } | (searchQuery: string, offset?: number | undefined): { filters: Filters<{ banned: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type: string; operators: "$eq"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte"… |
OfflineDBSyncManager.connectionChangedListener | { unsubscribe: () => void; } | null | any |
MessageReceiptsTracker.constructor | ({ locateMessage }: OwnMessageReceiptsTrackerOptions): MessageReceiptsTracker | ({ channel, locateMessage }: OwnMessageReceiptsTrackerOptions): MessageReceiptsTracker |
MessageReceiptsTracker.ingestInitial | (responses: ReadResponse[]): void | (responses: ReadStateResponse[]): void |
MessageReceiptsTracker.onMessageRead | ({ user, readAt, lastReadMessageId, }: { user: UserResponse; readAt: string; lastReadMessageId?: string | undefined; }): void | ({ user, readAt, lastReadMessageId, }: { user: UserResponse; readAt: TimestampNS; lastReadMessageId?: string | undefined; }): void |
MessageReceiptsTracker.onMessageDelivered | ({ user, deliveredAt, lastDeliveredMessageId, }: { user: UserResponse; deliveredAt: string; lastDeliveredMessageId?: string | undefined; }): void | ({ user, deliveredAt, lastDeliveredMessageId, }: { user: UserResponse; deliveredAt: TimestampNS; lastDeliveredMessageId?: string | undefined; }): void |
MessageReceiptsTracker.onNotificationMarkUnread | ({ user, lastReadAt, lastReadMessageId, }: { user: UserResponse; lastReadAt?: string | undefined; lastReadMessageId?: string | undefined; }): void | ({ user, lastReadAt, lastReadMessageId, }: { user: UserResponse; lastReadAt?: TimestampNS | undefined; lastReadMessageId?: string | undefined; }): void |
MessageDeliveryReporter.markRead | (collection: Thread | Channel, options?: MarkReadOptions | undefined): Promise<EventAPIResponse | null> | (collection: Channel | Thread, options?: MarkReadRequest | undefined): Promise<Partial<StreamResponse<MarkReadResponse>> | null> |
MessageDeliveryReporter.throttledMarkRead | (collection: Thread | Channel, options?: MarkReadOptions | undefined): void | (collection: Channel | Thread, options?: MarkReadRequest | undefined): void |
MessageDeliveryReporter.syncDeliveredCandidates | (collections: (Thread | Channel)[]): void | (collections: (Channel | Thread)[]): void |
MessageDeliveryReporter.markDeliveredRequestPromise | Promise<void | EventAPIResponse> | null | Promise<void> | null |
ChannelMemberSearchSource.sort | MemberSort | undefined | SortParamRequest[] | undefined |
ChannelMemberSearchSource.state | StateStore<SearchSourceState<ChannelMemberResponse>> | StateStore<SearchSourceState<T>> |
ChannelMemberSearchSource.filters | MemberFilters | undefined | Filters<{ banned: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type: string; operators: "$eq"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: CustomMemberData;… |
ChannelMemberSearchSource.constructor | <TFilterContext extends CustomContext = CustomContext>(channel: Channel, options?: ChannelMemberSearchSourceOptions | undefined, filterBuilderOptions?: FilterBuilderOptions<MemberFilters, ChannelMemberSearchSourceFilterBuilderContext<TFilterContext>> | undefined): ChannelMemberSearchSource<TFilterCo… | <TFilterContext extends CustomContext = CustomContext>(channel: Channel, options?: ChannelMemberSearchSourceOptions | undefined, filterBuilderOptions?: FilterBuilderOptions<Filters<{ banned: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type:… |
ChannelMemberSearchSource.filterBuilder | FilterBuilder<MemberFilters, ChannelMemberSearchSourceFilterBuilderContext<TFilterContext>> | FilterBuilder<Filters<{ banned: { type: boolean; operators: "$eq"; }; channel_role: { type: string; operators: "$eq" | "$in"; }; cid: { type: string; operators: "$eq"; }; created_at: { type: string | Date; operators: "$eq" | "$exists" | "$gt" | "$gte" | "$in" | "$lt" | "$lte"; }; custom: { type: Cus… |
ChannelMemberSearchSource.searchOptions | Omit<QueryMembersOptions, "limit" | "offset"> | undefined | Omit<Partial<Omit<QueryMembersPayload, "filter_conditions">>, "limit" | "offset"> | undefined |
MessageComposerMiddlewareExecutor.installedMiddleware | readonly MessageCompositionMiddleware[] | readonly Middleware<MessageComposerMiddlewareState, "compose">[] |
Baru ditandai usang
| export | @deprecated |
|---|---|
stream-chat · Thread.markAsRead | Use `thread.markRead` instead. |
stream-chat · StreamChat.userID | Use `userId` instead. |
stream-chat · StreamChat.clientID | Use `clientId` instead. |
stream-chat · StreamChat.setMessageComposerSetupFunction | Use `client.config.setSetupFunction('messageComposer', fn)`. |
stream-chat · AttachmentManager.fileUploadFilter | attachments can be filtered using injecting pre-upload middleware |
stream-chat · NotificationState | Use {@link NotificationManagerState} instead. |
stream-chat · StableWSConnection.onlineStatusChanged | Use `client.networkConnection.setStatus(isOnline)` or `client.networkConnection.setStatusReporter(…)` instead. |
Perubahan persyaratan (engines, dependensi peer)
| Sebelum | Sesudah | |
|---|---|---|
engines.node | >=18 | >=22.18.0 |
Ekspor baru (400)
| import | export | kind |
|---|---|---|
stream-chat | Data | interface |
stream-chat | Sink | variable |
stream-chat | nowNs | variable |
stream-chat | Images | interface |
stream-chat | msToNs | variable |
stream-chat | nsToMs | variable |
stream-chat | Filters | type |
stream-chat | OCRRule | interface |
stream-chat | WSEvent | type |
stream-chat | AIStates | variable |
stream-chat | APIError | interface |
stream-chat | FCHelper | type |
stream-chat | Interval | type |
stream-chat | Response | interface |
stream-chat | VoteData | interface |
stream-chat | dateToNs | variable |
stream-chat | nsToDate | variable |
stream-chat | EventType | type |
stream-chat | ImageData | interface |
stream-chat | ImageSize | interface |
stream-chat | NS_PER_MS | variable |
stream-chat | PushLevel | type |
stream-chat | RateLimit | type |
stream-chat | ReadState | type |
stream-chat | UserGroup | interface |
stream-chat | BanRequest | interface |
stream-chat | ClientUser | type |
stream-chat | ConfigNode | type |
stream-chat | HarmConfig | interface |
stream-chat | OnlyUserID | interface |
stream-chat | AnyInterval | type |
stream-chat | AutomodMode | type |
stream-chat | BanResponse | interface |
stream-chat | ConfigShape | type |
stream-chat | CustomEvent | interface |
stream-chat | DeepPartial | type |
stream-chat | EntityStore | class |
stream-chat | FilterValue | type |
stream-chat | FlagRequest | interface |
stream-chat | FloodConfig | interface |
stream-chat | MuteRequest | interface |
stream-chat | SyncRequest | interface |
stream-chat | TimestampNS | type |
stream-chat | UserRequest | interface |
stream-chat | nsToRfc3339 | variable |
stream-chat | ChannelInput | interface |
stream-chat | ChannelUsage | type |
stream-chat | CustomHelper | type |
stream-chat | EventPayload | type |
stream-chat | EventRequest | interface |
stream-chat | LogLevelEnum | variable |
stream-chat | MembersState | type |
stream-chat | ScopedLogger | type |
stream-chat | SearchResult | interface |
stream-chat | ThreadConfig | type |
stream-chat | UnbanRequest | interface |
stream-chat | WSConnection | class |
stream-chat | AppealRequest | interface |
stream-chat | BodyguardRule | interface |
stream-chat | CommentStatus | type |
stream-chat | EventResponse | interface |
stream-chat | GetOGResponse | interface |
stream-chat | LabelResponse | interface |
stream-chat | LiveViewState | type |
stream-chat | MessageUpdate | interface |
stream-chat | OperationKind | type |
stream-chat | PendingTaskOf | type |
stream-chat | PipelineEvent | type |
stream-chat | QueueResponse | interface |
stream-chat | QueueableType | type |
stream-chat | SortParamType | type |
stream-chat | UnbanResponse | interface |
stream-chat | UnmuteRequest | interface |
stream-chat | WSAuthMessage | interface |
stream-chat | WSClientEvent | type |
stream-chat | asTimestampNS | variable |
stream-chat | ActionSequence | interface |
stream-chat | AppealResponse | interface |
stream-chat | ConfigResponse | interface |
stream-chat | ConnectedEvent | interface |
stream-chat | ConnectionType | type |
stream-chat | DeleteMessages | type |
stream-chat | DeviceResponse | interface |
stream-chat | FeedVisibility | type |
stream-chat | LANGUAGE_NAMES | variable |
stream-chat | MessageRequest | interface |
stream-chat | RequireLiteral | type |
stream-chat | SearchResponse | interface |
stream-chat | SharedLocation | interface |
stream-chat | StreamAPIError | class |
stream-chat | StreamResponse | type |
stream-chat | UnmuteResponse | interface |
stream-chat | UserMutedEvent | interface |
stream-chat | isFailedUpload | variable |
stream-chat | AppUpdatedEvent | interface |
stream-chat | BanInfoResponse | interface |
stream-chat | BulkAppealError | interface |
stream-chat | ChannelMetadata | interface |
stream-chat | ChatLoggerScope | type |
stream-chat | ConfigGroupNode | type |
stream-chat | ConfigValueNode | type |
stream-chat | ConfigValueType | type |
stream-chat | CursorDerivator | type |
stream-chat | EscalatePayload | interface |
stream-chat | FileUploadInput | type |
stream-chat | ItemCoordinates | type |
stream-chat | LabelThresholds | interface |
stream-chat | LogicalInterval | type |
stream-chat | MarkReadRequest | interface |
stream-chat | MembersResponse | interface |
stream-chat | MembershipState | type |
stream-chat | MessageNewEvent | interface |
stream-chat | MuteStatusState | type |
stream-chat | OperationParams | type |
stream-chat | PaginationFlags | type |
stream-chat | PaginatorCursor | type |
stream-chat | PaginatorPlugin | interface |
stream-chat | PollClosedEvent | interface |
stream-chat | PollOptionInput | interface |
stream-chat | QueueableResult | type |
stream-chat | ReactionRequest | interface |
stream-chat | RequestMetadata | type |
stream-chat | RestrictReplies | type |
stream-chat | ThreadPaginator | class |
stream-chat | TypingStopEvent | interface |
stream-chat | UserBannedEvent | interface |
stream-chat | UserGroupMember | interface |
stream-chat | AIIndicatorState | type |
stream-chat | AppEventResponse | interface |
stream-chat | BulkAppealResult | interface |
stream-chat | ChannelDataState | type |
stream-chat | ChannelPaginator | class |
stream-chat | ChannelStateData | type |
stream-chat | CollectionStatus | type |
stream-chat | EnrichedActivity | interface |
stream-chat | EnrichedReaction | interface |
stream-chat | EntityStoreClaim | type |
stream-chat | FlagItemResponse | interface |
stream-chat | FullUserResponse | interface |
stream-chat | HealthCheckEvent | interface |
stream-chat | InstanceConfigOf | type |
stream-chat | InstanceSetupKey | type |
stream-chat | MarkReadResponse | interface |
stream-chat | MemberAddedEvent | interface |
stream-chat | MessageChangeSet | interface |
stream-chat | MessagePaginator | class |
stream-chat | MessageReadEvent | interface |
stream-chat | PaginationParams | interface |
stream-chat | PartializeAllBut | type |
stream-chat | PollDeletedEvent | interface |
stream-chat | PollResponseData | interface |
stream-chat | PollUpdatedEvent | interface |
stream-chat | PollVoteResponse | interface |
stream-chat | PushProviderName | type |
stream-chat | QueueablePayload | type |
stream-chat | ReactionNewEvent | interface |
stream-chat | SendEventRequest | interface |
stream-chat | SortParamRequest | interface |
stream-chat | TypingUsersState | type |
stream-chat | UserClaimedEvent | interface |
stream-chat | UserDeletedEvent | interface |
stream-chat | UserMuteResponse | interface |
stream-chat | UserUpdatedEvent | interface |
stream-chat | ZERO_PAGE_CURSOR | variable |
stream-chat | chatLoggerSystem | variable |
stream-chat | ActionLogResponse | interface |
stream-chat | AddMembersRequest | type |
stream-chat | AppResponseFields | interface |
stream-chat | BlockUsersRequest | interface |
stream-chat | CallActionOptions | interface |
stream-chat | ChannelMuteStatus | type |
stream-chat | ChannelQueryShape | type |
stream-chat | ChannelWatchState | type |
stream-chat | ChatDraftResponse | interface |
stream-chat | CreatePollRequest | interface |
stream-chat | DoRequestResponse | type |
stream-chat | DraftDeletedEvent | interface |
stream-chat | DraftUpdatedEvent | interface |
stream-chat | FeedsFeedResponse | interface |
stream-chat | FileReferenceBase | type |
stream-chat | FileUploadRequest | interface |
stream-chat | FilterTagsRequest | type |
stream-chat | ForkChannelTarget | interface |
stream-chat | GetAppealResponse | interface |
stream-chat | GetThreadResponse | interface |
stream-chat | MarkUnreadRequest | interface |
stream-chat | MemberUserRequest | interface |
stream-chat | MessageQueryShape | type |
stream-chat | OperationResponse | type |
stream-chat | PinMessageOptions | type |
stream-chat | PollOptionRequest | interface |
stream-chat | PollVotesResponse | interface |
stream-chat | PushScheduleInput | interface |
stream-chat | QueryPollsRequest | interface |
stream-chat | QueryUsersPayload | interface |
stream-chat | ReadStateResponse | interface |
stream-chat | RuleBuilderConfig | interface |
stream-chat | ServerUpperBounds | type |
stream-chat | ThreadParticipant | interface |
stream-chat | UpdatePollRequest | interface |
Berikan fakta ini ke agen AI Anda
Vigia adalah server MCP gratis: agen coding Anda memeriksa versi, perubahan yang merusak kompatibilitas, dan kerentanan sebelum menulis kode. Tanpa pendaftaran, tanpa kunci API.
claude mcp add --transport http vigia https://vigia.coredls.cloud/mcp
Tambahkan ke CursorTambahkan ke VS Code★ Bintang di GitHub
Klien MCP lainnya
{ "mcpServers": { "vigia": { "url": "https://vigia.coredls.cloud/mcp" } } }Skill agen (SKILL.md): memberi tahu agen kapan memakai Vigia · GitHub Action untuk pull request
Pertanyaan umum
Apa saja perubahan tidak kompatibel saat memperbarui stream-chat dari 9 ke 10?
Antara stream-chat 9.55.0 dan 10.0.0, Vigia menemukan 454 ekspor yang dihapus, 243 tanda tangan yang berubah, dan 665 anggota kelas atau antarmuka yang dihapus atau berubah.
Apa yang ditandai usang di stream-chat 10?
7 ekspor atau anggota baru ditandai usang di stream-chat 10.0.0.
Untuk agen
GET https://vigia.coredls.cloud/v1/packages/npm/stream-chat/upgrade?from=9.55.0&to=10.0.0