@ermis-network/ermis-chat-sdk 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.browser.cjs +211 -52
- package/dist/index.browser.cjs.map +1 -1
- package/dist/index.browser.full-bundle.min.js +2 -2
- package/dist/index.browser.full-bundle.min.js.map +1 -1
- package/dist/index.browser.mjs +211 -52
- package/dist/index.browser.mjs.map +1 -1
- package/dist/index.cjs +211 -52
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +47 -16
- package/dist/index.d.ts +47 -16
- package/dist/index.mjs +211 -52
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/channel.ts +65 -3
- package/src/client.ts +159 -50
- package/src/types.ts +14 -0
package/dist/index.d.mts
CHANGED
|
@@ -222,6 +222,7 @@ type ChannelResponse<ErmisChatGenerics extends ExtendableGenerics = DefaultGener
|
|
|
222
222
|
member_capabilities?: string[];
|
|
223
223
|
is_pinned?: boolean;
|
|
224
224
|
topics_enabled?: boolean;
|
|
225
|
+
parent_cid?: string;
|
|
225
226
|
is_closed_topic?: boolean;
|
|
226
227
|
};
|
|
227
228
|
type QueryChannelsAPIResponse<ErmisChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
@@ -401,6 +402,7 @@ type Event$1<ErmisChatGenerics extends ExtendableGenerics = DefaultGenerics> = E
|
|
|
401
402
|
message?: MessageResponse<ErmisChatGenerics>;
|
|
402
403
|
online?: boolean;
|
|
403
404
|
parent_id?: string;
|
|
405
|
+
parent_cid?: string;
|
|
404
406
|
reaction?: ReactionResponse<ErmisChatGenerics>;
|
|
405
407
|
received_at?: string | Date;
|
|
406
408
|
unread_messages?: number;
|
|
@@ -428,6 +430,16 @@ type ChannelFilters = {
|
|
|
428
430
|
parent_id?: string;
|
|
429
431
|
include_parent?: boolean;
|
|
430
432
|
};
|
|
433
|
+
type CreateTopicData = {
|
|
434
|
+
name: string;
|
|
435
|
+
image?: string;
|
|
436
|
+
[key: string]: any;
|
|
437
|
+
};
|
|
438
|
+
type EditTopicData = {
|
|
439
|
+
name?: string;
|
|
440
|
+
image?: string;
|
|
441
|
+
description?: string;
|
|
442
|
+
};
|
|
431
443
|
type ChannelSort = {
|
|
432
444
|
field: string;
|
|
433
445
|
direction: -1 | 1;
|
|
@@ -863,6 +875,8 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
|
|
|
863
875
|
}): Promise<SendMessageAPIResponse<ErmisChatGenerics>>;
|
|
864
876
|
pinMessage(messageID: string): Promise<unknown>;
|
|
865
877
|
unpinMessage(messageID: string): Promise<unknown>;
|
|
878
|
+
pin(): Promise<APIResponse>;
|
|
879
|
+
unpin(): Promise<APIResponse>;
|
|
866
880
|
editMessage(oldMessageID: string, message: EditMessage): Promise<unknown>;
|
|
867
881
|
sendFile(uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse<ErmisChatGenerics>): Promise<SendFileAPIResponse>;
|
|
868
882
|
/**
|
|
@@ -961,7 +975,7 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
|
|
|
961
975
|
}[];
|
|
962
976
|
getCapabilitiesMember(): unknown;
|
|
963
977
|
create: () => Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
|
|
964
|
-
createTopic(data:
|
|
978
|
+
createTopic(data: CreateTopicData): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
|
|
965
979
|
query(options: ChannelQueryOptions, messageSetToAddToIfDoesNotExist?: MessageSetType): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
|
|
966
980
|
createDirectChannel(messageSetToAddToIfDoesNotExist?: MessageSetType): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
|
|
967
981
|
queryMessagesLessThanId(message_id: string, limit?: number): Promise<MessageResponse<ErmisChatGenerics>[]>;
|
|
@@ -978,7 +992,7 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
|
|
|
978
992
|
disableTopics(): Promise<unknown>;
|
|
979
993
|
closeTopic(topicCID: string): Promise<unknown>;
|
|
980
994
|
reopenTopic(topicCID: string): Promise<unknown>;
|
|
981
|
-
editTopic(topicCID: string, data:
|
|
995
|
+
editTopic(topicCID: string, data: EditTopicData): Promise<any>;
|
|
982
996
|
on(eventType: EventTypes, callback: EventHandler<ErmisChatGenerics>): {
|
|
983
997
|
unsubscribe: () => void;
|
|
984
998
|
};
|
|
@@ -1132,8 +1146,8 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
|
|
|
1132
1146
|
* @param extenal_auth - Set to `true` to use your custom backend external authentication flow.
|
|
1133
1147
|
* @returns A promise resolving to the API connection response once authenticated.
|
|
1134
1148
|
*/
|
|
1135
|
-
connectUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null,
|
|
1136
|
-
setUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null,
|
|
1149
|
+
connectUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, external_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
|
|
1150
|
+
setUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, external_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
|
|
1137
1151
|
_setToken: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null) => Promise<void>;
|
|
1138
1152
|
_setUser(user: UserResponse<ErmisChatGenerics>): void;
|
|
1139
1153
|
closeConnection: (timeout?: number) => Promise<void>;
|
|
@@ -1196,6 +1210,15 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
|
|
|
1196
1210
|
patch<T>(url: string, data?: unknown): Promise<T>;
|
|
1197
1211
|
delete<T>(url: string, params?: AxiosRequestConfig['params']): Promise<T>;
|
|
1198
1212
|
sendFile(url: string, uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse<ErmisChatGenerics>): Promise<SendFileAPIResponse>;
|
|
1213
|
+
/**
|
|
1214
|
+
* Downloads a media file as a Blob via the SDK's configured axiosInstance.
|
|
1215
|
+
* This avoids CORS issues that arise when using `fetch()` directly from the browser,
|
|
1216
|
+
* because axios is routed through the SDK's authenticated transport layer.
|
|
1217
|
+
*
|
|
1218
|
+
* @param url - The full URL of the media file to download.
|
|
1219
|
+
* @returns A Blob of the file content.
|
|
1220
|
+
*/
|
|
1221
|
+
downloadMedia(url: string): Promise<Blob>;
|
|
1199
1222
|
errorFromResponse(response: AxiosResponse<APIErrorResponse>): ErrorFromResponse<APIErrorResponse>;
|
|
1200
1223
|
handleResponse<T>(response: AxiosResponse<T>): T;
|
|
1201
1224
|
dispatchEvent: (event: Event$1<ErmisChatGenerics>) => void;
|
|
@@ -1218,10 +1241,17 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
|
|
|
1218
1241
|
searchUsers(page: number, page_size: number, name?: string): Promise<UsersResponse>;
|
|
1219
1242
|
queryContacts(): Promise<ContactResult>;
|
|
1220
1243
|
_updateProjectID(project_id: string): void;
|
|
1221
|
-
|
|
1244
|
+
/**
|
|
1245
|
+
* Uploads a new avatar image for the current user.
|
|
1246
|
+
* The user's avatar URL is automatically updated in both the client and the local state.
|
|
1247
|
+
*
|
|
1248
|
+
* @param file - The image file to upload.
|
|
1249
|
+
* @returns The response containing the new avatar URL.
|
|
1250
|
+
*/
|
|
1251
|
+
uploadAvatar(file: File): Promise<{
|
|
1222
1252
|
avatar: string;
|
|
1223
1253
|
}>;
|
|
1224
|
-
updateProfile(
|
|
1254
|
+
updateProfile(updates: Partial<UserResponse<ErmisChatGenerics>>): Promise<UserResponse<ErmisChatGenerics>>;
|
|
1225
1255
|
/**
|
|
1226
1256
|
* Queries the API for a list of channels based on provided search filters and sort conditions.
|
|
1227
1257
|
* Also hydrates these channels into the local SDK state memory.
|
|
@@ -1263,22 +1293,23 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
|
|
|
1263
1293
|
getChannelById: (channelType: string, channelID: string | undefined, custom: ChannelData<ErmisChatGenerics>) => Channel<ErmisChatGenerics>;
|
|
1264
1294
|
getChannel: (channelType: string, custom: ChannelData<ErmisChatGenerics>) => Channel<ErmisChatGenerics>;
|
|
1265
1295
|
/**
|
|
1266
|
-
* Creates
|
|
1267
|
-
*
|
|
1296
|
+
* Creates a quick channel and immediately registers it on the server.
|
|
1297
|
+
* Quick channels are public group channels that anyone can join without an invitation.
|
|
1298
|
+
* The creator is added as the first member automatically.
|
|
1268
1299
|
*
|
|
1269
|
-
* @param name -
|
|
1300
|
+
* @param name - An optional display name for the channel.
|
|
1270
1301
|
* @returns A promise that resolves to the created `Channel` object.
|
|
1271
1302
|
*/
|
|
1272
|
-
|
|
1303
|
+
createQuickChannel(name?: string): Promise<Channel<ErmisChatGenerics>>;
|
|
1273
1304
|
/**
|
|
1274
|
-
* Joins a
|
|
1275
|
-
*
|
|
1276
|
-
* If not, it
|
|
1305
|
+
* Joins a quick channel by its ID.
|
|
1306
|
+
* Automatically checks whether the caller is already a member.
|
|
1307
|
+
* If not, it joins the channel and synchronizes state.
|
|
1277
1308
|
*
|
|
1278
|
-
* @param channelId - The ID of the
|
|
1309
|
+
* @param channelId - The ID of the quick channel to join.
|
|
1279
1310
|
* @returns A promise that resolves to the joined `Channel` object.
|
|
1280
1311
|
*/
|
|
1281
|
-
|
|
1312
|
+
joinQuickChannel(channelId: string): Promise<Channel<ErmisChatGenerics>>;
|
|
1282
1313
|
_normalizeExpiration(timeoutOrExpirationDate?: null | number | string | Date): string | null;
|
|
1283
1314
|
getUserAgent(): string;
|
|
1284
1315
|
setUserAgent(userAgent: string): void;
|
|
@@ -1676,4 +1707,4 @@ interface SignalMessageResult {
|
|
|
1676
1707
|
*/
|
|
1677
1708
|
declare function parseSignalMessage(value: string, myUserId: string): SignalMessageResult | null;
|
|
1678
1709
|
|
|
1679
|
-
export { type APIErrorResponse, type APIResponse, type AscDesc, type Attachment, type AttachmentResponse, type AudioConfig, CallAction, type CallEventData, type CallEventType, CallStatus, CallType, type CallTypeValue, Channel, type ChannelAPIResponse, type ChannelData, type ChannelFilters, type ChannelMemberResponse, type ChannelMembership, type ChannelQueryOptions, type ChannelResponse, type ChannelSort, ChannelState, type ChannelStateOptions, ClientState, type ConnectAPIResponse, type ConnectionOpen, type Contact, type ContactResponse, type ContactResult, type DefaultGenerics, EVENT_MAP, type EditMessage, ErmisAuthProvider, ErmisCallNode, ErmisChat, type ErmisChatOptions, ErrorFromResponse, type Event$1 as Event, type EventHandler, type EventTypes, type ExtendableGenerics, FRAME_TYPE, type FormatMessageResponse, type ForwardMessage, type IMediaReceiverEvents, type INodeCall, type LiteralStringForUnion, type LogLevel, type Logger, type Message, type MessageBase, type MessageLabel, type MessageResponse, type MessageResponseBase, type MessageSetType, type Metadata, type PollMessage, type QueryChannelAPIResponse, type QueryChannelsAPIResponse, type Reaction, type ReactionAPIResponse, type ReactionResponse, type ReadResponse, type Role, type SendFileAPIResponse, type SendMessageAPIResponse, type SignalData, type SignalMessageResult, StableWSConnection, TokenManager, type TransceiverState, type UR, type UpdateChannelAPIResponse, type UserCallInfo, type UserResponse, type UsersResponse, type VideoConfig, type VoiceRecordingMeta, buildAttachmentPayload, chatCodes, createForwardMessagePayload, formatMessage, getAttachmentCategory, isHeicFile, isVideoFile, logChatPromiseExecution, normalizeFileName, parseSignalMessage, parseSystemMessage };
|
|
1710
|
+
export { type APIErrorResponse, type APIResponse, type AscDesc, type Attachment, type AttachmentResponse, type AudioConfig, CallAction, type CallEventData, type CallEventType, CallStatus, CallType, type CallTypeValue, Channel, type ChannelAPIResponse, type ChannelData, type ChannelFilters, type ChannelMemberResponse, type ChannelMembership, type ChannelQueryOptions, type ChannelResponse, type ChannelSort, ChannelState, type ChannelStateOptions, ClientState, type ConnectAPIResponse, type ConnectionOpen, type Contact, type ContactResponse, type ContactResult, type CreateTopicData, type DefaultGenerics, EVENT_MAP, type EditMessage, type EditTopicData, ErmisAuthProvider, ErmisCallNode, ErmisChat, type ErmisChatOptions, ErrorFromResponse, type Event$1 as Event, type EventHandler, type EventTypes, type ExtendableGenerics, FRAME_TYPE, type FormatMessageResponse, type ForwardMessage, type IMediaReceiverEvents, type INodeCall, type LiteralStringForUnion, type LogLevel, type Logger, type Message, type MessageBase, type MessageLabel, type MessageResponse, type MessageResponseBase, type MessageSetType, type Metadata, type PollMessage, type QueryChannelAPIResponse, type QueryChannelsAPIResponse, type Reaction, type ReactionAPIResponse, type ReactionResponse, type ReadResponse, type Role, type SendFileAPIResponse, type SendMessageAPIResponse, type SignalData, type SignalMessageResult, StableWSConnection, TokenManager, type TransceiverState, type UR, type UpdateChannelAPIResponse, type UserCallInfo, type UserResponse, type UsersResponse, type VideoConfig, type VoiceRecordingMeta, buildAttachmentPayload, chatCodes, createForwardMessagePayload, formatMessage, getAttachmentCategory, isHeicFile, isVideoFile, logChatPromiseExecution, normalizeFileName, parseSignalMessage, parseSystemMessage };
|
package/dist/index.d.ts
CHANGED
|
@@ -222,6 +222,7 @@ type ChannelResponse<ErmisChatGenerics extends ExtendableGenerics = DefaultGener
|
|
|
222
222
|
member_capabilities?: string[];
|
|
223
223
|
is_pinned?: boolean;
|
|
224
224
|
topics_enabled?: boolean;
|
|
225
|
+
parent_cid?: string;
|
|
225
226
|
is_closed_topic?: boolean;
|
|
226
227
|
};
|
|
227
228
|
type QueryChannelsAPIResponse<ErmisChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
@@ -401,6 +402,7 @@ type Event$1<ErmisChatGenerics extends ExtendableGenerics = DefaultGenerics> = E
|
|
|
401
402
|
message?: MessageResponse<ErmisChatGenerics>;
|
|
402
403
|
online?: boolean;
|
|
403
404
|
parent_id?: string;
|
|
405
|
+
parent_cid?: string;
|
|
404
406
|
reaction?: ReactionResponse<ErmisChatGenerics>;
|
|
405
407
|
received_at?: string | Date;
|
|
406
408
|
unread_messages?: number;
|
|
@@ -428,6 +430,16 @@ type ChannelFilters = {
|
|
|
428
430
|
parent_id?: string;
|
|
429
431
|
include_parent?: boolean;
|
|
430
432
|
};
|
|
433
|
+
type CreateTopicData = {
|
|
434
|
+
name: string;
|
|
435
|
+
image?: string;
|
|
436
|
+
[key: string]: any;
|
|
437
|
+
};
|
|
438
|
+
type EditTopicData = {
|
|
439
|
+
name?: string;
|
|
440
|
+
image?: string;
|
|
441
|
+
description?: string;
|
|
442
|
+
};
|
|
431
443
|
type ChannelSort = {
|
|
432
444
|
field: string;
|
|
433
445
|
direction: -1 | 1;
|
|
@@ -863,6 +875,8 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
|
|
|
863
875
|
}): Promise<SendMessageAPIResponse<ErmisChatGenerics>>;
|
|
864
876
|
pinMessage(messageID: string): Promise<unknown>;
|
|
865
877
|
unpinMessage(messageID: string): Promise<unknown>;
|
|
878
|
+
pin(): Promise<APIResponse>;
|
|
879
|
+
unpin(): Promise<APIResponse>;
|
|
866
880
|
editMessage(oldMessageID: string, message: EditMessage): Promise<unknown>;
|
|
867
881
|
sendFile(uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse<ErmisChatGenerics>): Promise<SendFileAPIResponse>;
|
|
868
882
|
/**
|
|
@@ -961,7 +975,7 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
|
|
|
961
975
|
}[];
|
|
962
976
|
getCapabilitiesMember(): unknown;
|
|
963
977
|
create: () => Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
|
|
964
|
-
createTopic(data:
|
|
978
|
+
createTopic(data: CreateTopicData): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
|
|
965
979
|
query(options: ChannelQueryOptions, messageSetToAddToIfDoesNotExist?: MessageSetType): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
|
|
966
980
|
createDirectChannel(messageSetToAddToIfDoesNotExist?: MessageSetType): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
|
|
967
981
|
queryMessagesLessThanId(message_id: string, limit?: number): Promise<MessageResponse<ErmisChatGenerics>[]>;
|
|
@@ -978,7 +992,7 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
|
|
|
978
992
|
disableTopics(): Promise<unknown>;
|
|
979
993
|
closeTopic(topicCID: string): Promise<unknown>;
|
|
980
994
|
reopenTopic(topicCID: string): Promise<unknown>;
|
|
981
|
-
editTopic(topicCID: string, data:
|
|
995
|
+
editTopic(topicCID: string, data: EditTopicData): Promise<any>;
|
|
982
996
|
on(eventType: EventTypes, callback: EventHandler<ErmisChatGenerics>): {
|
|
983
997
|
unsubscribe: () => void;
|
|
984
998
|
};
|
|
@@ -1132,8 +1146,8 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
|
|
|
1132
1146
|
* @param extenal_auth - Set to `true` to use your custom backend external authentication flow.
|
|
1133
1147
|
* @returns A promise resolving to the API connection response once authenticated.
|
|
1134
1148
|
*/
|
|
1135
|
-
connectUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null,
|
|
1136
|
-
setUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null,
|
|
1149
|
+
connectUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, external_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
|
|
1150
|
+
setUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, external_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
|
|
1137
1151
|
_setToken: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null) => Promise<void>;
|
|
1138
1152
|
_setUser(user: UserResponse<ErmisChatGenerics>): void;
|
|
1139
1153
|
closeConnection: (timeout?: number) => Promise<void>;
|
|
@@ -1196,6 +1210,15 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
|
|
|
1196
1210
|
patch<T>(url: string, data?: unknown): Promise<T>;
|
|
1197
1211
|
delete<T>(url: string, params?: AxiosRequestConfig['params']): Promise<T>;
|
|
1198
1212
|
sendFile(url: string, uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse<ErmisChatGenerics>): Promise<SendFileAPIResponse>;
|
|
1213
|
+
/**
|
|
1214
|
+
* Downloads a media file as a Blob via the SDK's configured axiosInstance.
|
|
1215
|
+
* This avoids CORS issues that arise when using `fetch()` directly from the browser,
|
|
1216
|
+
* because axios is routed through the SDK's authenticated transport layer.
|
|
1217
|
+
*
|
|
1218
|
+
* @param url - The full URL of the media file to download.
|
|
1219
|
+
* @returns A Blob of the file content.
|
|
1220
|
+
*/
|
|
1221
|
+
downloadMedia(url: string): Promise<Blob>;
|
|
1199
1222
|
errorFromResponse(response: AxiosResponse<APIErrorResponse>): ErrorFromResponse<APIErrorResponse>;
|
|
1200
1223
|
handleResponse<T>(response: AxiosResponse<T>): T;
|
|
1201
1224
|
dispatchEvent: (event: Event$1<ErmisChatGenerics>) => void;
|
|
@@ -1218,10 +1241,17 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
|
|
|
1218
1241
|
searchUsers(page: number, page_size: number, name?: string): Promise<UsersResponse>;
|
|
1219
1242
|
queryContacts(): Promise<ContactResult>;
|
|
1220
1243
|
_updateProjectID(project_id: string): void;
|
|
1221
|
-
|
|
1244
|
+
/**
|
|
1245
|
+
* Uploads a new avatar image for the current user.
|
|
1246
|
+
* The user's avatar URL is automatically updated in both the client and the local state.
|
|
1247
|
+
*
|
|
1248
|
+
* @param file - The image file to upload.
|
|
1249
|
+
* @returns The response containing the new avatar URL.
|
|
1250
|
+
*/
|
|
1251
|
+
uploadAvatar(file: File): Promise<{
|
|
1222
1252
|
avatar: string;
|
|
1223
1253
|
}>;
|
|
1224
|
-
updateProfile(
|
|
1254
|
+
updateProfile(updates: Partial<UserResponse<ErmisChatGenerics>>): Promise<UserResponse<ErmisChatGenerics>>;
|
|
1225
1255
|
/**
|
|
1226
1256
|
* Queries the API for a list of channels based on provided search filters and sort conditions.
|
|
1227
1257
|
* Also hydrates these channels into the local SDK state memory.
|
|
@@ -1263,22 +1293,23 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
|
|
|
1263
1293
|
getChannelById: (channelType: string, channelID: string | undefined, custom: ChannelData<ErmisChatGenerics>) => Channel<ErmisChatGenerics>;
|
|
1264
1294
|
getChannel: (channelType: string, custom: ChannelData<ErmisChatGenerics>) => Channel<ErmisChatGenerics>;
|
|
1265
1295
|
/**
|
|
1266
|
-
* Creates
|
|
1267
|
-
*
|
|
1296
|
+
* Creates a quick channel and immediately registers it on the server.
|
|
1297
|
+
* Quick channels are public group channels that anyone can join without an invitation.
|
|
1298
|
+
* The creator is added as the first member automatically.
|
|
1268
1299
|
*
|
|
1269
|
-
* @param name -
|
|
1300
|
+
* @param name - An optional display name for the channel.
|
|
1270
1301
|
* @returns A promise that resolves to the created `Channel` object.
|
|
1271
1302
|
*/
|
|
1272
|
-
|
|
1303
|
+
createQuickChannel(name?: string): Promise<Channel<ErmisChatGenerics>>;
|
|
1273
1304
|
/**
|
|
1274
|
-
* Joins a
|
|
1275
|
-
*
|
|
1276
|
-
* If not, it
|
|
1305
|
+
* Joins a quick channel by its ID.
|
|
1306
|
+
* Automatically checks whether the caller is already a member.
|
|
1307
|
+
* If not, it joins the channel and synchronizes state.
|
|
1277
1308
|
*
|
|
1278
|
-
* @param channelId - The ID of the
|
|
1309
|
+
* @param channelId - The ID of the quick channel to join.
|
|
1279
1310
|
* @returns A promise that resolves to the joined `Channel` object.
|
|
1280
1311
|
*/
|
|
1281
|
-
|
|
1312
|
+
joinQuickChannel(channelId: string): Promise<Channel<ErmisChatGenerics>>;
|
|
1282
1313
|
_normalizeExpiration(timeoutOrExpirationDate?: null | number | string | Date): string | null;
|
|
1283
1314
|
getUserAgent(): string;
|
|
1284
1315
|
setUserAgent(userAgent: string): void;
|
|
@@ -1676,4 +1707,4 @@ interface SignalMessageResult {
|
|
|
1676
1707
|
*/
|
|
1677
1708
|
declare function parseSignalMessage(value: string, myUserId: string): SignalMessageResult | null;
|
|
1678
1709
|
|
|
1679
|
-
export { type APIErrorResponse, type APIResponse, type AscDesc, type Attachment, type AttachmentResponse, type AudioConfig, CallAction, type CallEventData, type CallEventType, CallStatus, CallType, type CallTypeValue, Channel, type ChannelAPIResponse, type ChannelData, type ChannelFilters, type ChannelMemberResponse, type ChannelMembership, type ChannelQueryOptions, type ChannelResponse, type ChannelSort, ChannelState, type ChannelStateOptions, ClientState, type ConnectAPIResponse, type ConnectionOpen, type Contact, type ContactResponse, type ContactResult, type DefaultGenerics, EVENT_MAP, type EditMessage, ErmisAuthProvider, ErmisCallNode, ErmisChat, type ErmisChatOptions, ErrorFromResponse, type Event$1 as Event, type EventHandler, type EventTypes, type ExtendableGenerics, FRAME_TYPE, type FormatMessageResponse, type ForwardMessage, type IMediaReceiverEvents, type INodeCall, type LiteralStringForUnion, type LogLevel, type Logger, type Message, type MessageBase, type MessageLabel, type MessageResponse, type MessageResponseBase, type MessageSetType, type Metadata, type PollMessage, type QueryChannelAPIResponse, type QueryChannelsAPIResponse, type Reaction, type ReactionAPIResponse, type ReactionResponse, type ReadResponse, type Role, type SendFileAPIResponse, type SendMessageAPIResponse, type SignalData, type SignalMessageResult, StableWSConnection, TokenManager, type TransceiverState, type UR, type UpdateChannelAPIResponse, type UserCallInfo, type UserResponse, type UsersResponse, type VideoConfig, type VoiceRecordingMeta, buildAttachmentPayload, chatCodes, createForwardMessagePayload, formatMessage, getAttachmentCategory, isHeicFile, isVideoFile, logChatPromiseExecution, normalizeFileName, parseSignalMessage, parseSystemMessage };
|
|
1710
|
+
export { type APIErrorResponse, type APIResponse, type AscDesc, type Attachment, type AttachmentResponse, type AudioConfig, CallAction, type CallEventData, type CallEventType, CallStatus, CallType, type CallTypeValue, Channel, type ChannelAPIResponse, type ChannelData, type ChannelFilters, type ChannelMemberResponse, type ChannelMembership, type ChannelQueryOptions, type ChannelResponse, type ChannelSort, ChannelState, type ChannelStateOptions, ClientState, type ConnectAPIResponse, type ConnectionOpen, type Contact, type ContactResponse, type ContactResult, type CreateTopicData, type DefaultGenerics, EVENT_MAP, type EditMessage, type EditTopicData, ErmisAuthProvider, ErmisCallNode, ErmisChat, type ErmisChatOptions, ErrorFromResponse, type Event$1 as Event, type EventHandler, type EventTypes, type ExtendableGenerics, FRAME_TYPE, type FormatMessageResponse, type ForwardMessage, type IMediaReceiverEvents, type INodeCall, type LiteralStringForUnion, type LogLevel, type Logger, type Message, type MessageBase, type MessageLabel, type MessageResponse, type MessageResponseBase, type MessageSetType, type Metadata, type PollMessage, type QueryChannelAPIResponse, type QueryChannelsAPIResponse, type Reaction, type ReactionAPIResponse, type ReactionResponse, type ReadResponse, type Role, type SendFileAPIResponse, type SendMessageAPIResponse, type SignalData, type SignalMessageResult, StableWSConnection, TokenManager, type TransceiverState, type UR, type UpdateChannelAPIResponse, type UserCallInfo, type UserResponse, type UsersResponse, type VideoConfig, type VoiceRecordingMeta, buildAttachmentPayload, chatCodes, createForwardMessagePayload, formatMessage, getAttachmentCategory, isHeicFile, isVideoFile, logChatPromiseExecution, normalizeFileName, parseSignalMessage, parseSystemMessage };
|