@ale-rainbow/web-sdk 5.1.0

package/lib/services/channels/channel.service.d.ts

@@ -0,0 +1,626 @@
+/**
+ * @module Channels
+ */
+import type { Subscription } from "rxjs";
+import type { Channel, ChannelAggregated, ChannelGetUsersOptions, ChannelSearchUsersOptions, ChannelSettings, ChannelUser } from "../../models/channel.model";
+import { ChannelRB, ChannelConfidentiality, ChannelUserRole, ChannelVisibility } from "../../models/channel.model";
+import type { ChannelPost, ChannelPostUserReactions } from "../../models/channelMessage.model";
+import { ChannelMessage, ChannelPostReaction } from "../../models/channelMessage.model";
+import { RBEvent } from "../../models/event.model";
+import { Service } from "../../services/service";
+import type { StropheHandler } from "../../libs/strophe/types";
+/**
+ * @internal
+ */
+export declare const CHANNEL_SVC = "ChannelService";
+/**
+ * @eventProperty
+ * This enum lists all the `RBEvent` events generated by the Channel service.
+ * They can be listened to using the `channelService.subscribe()` API.
+ */
+export declare enum ChannelServiceEvents {
+    /**
+     * @eventProperty
+     * This `RBEvent` is send when the channel service is started and ready to be used (also fired after loss of network and reconnection)
+     */
+    ON_SERVICE_STARTED = "ON_SERVICE_STARTED",
+    /**
+     * @eventProperty
+     * This RBEvent is sent when the connected user has received an invitation to susbcribe to a channel.
+     * At the end of the process, the user will be added in the channel.
+     * **Event Data**
+     * - **channel**: The channel for which the invitation was sent.
+     */
+    ON_CONNECTED_USER_INVITATION_RECEIVED = "ON_CONNECTED_USER_INVITATION_RECEIVED",
+    /**
+     * @eventProperty
+     * This RBEvent is sent when the connected user has declined an invitation to join a channel.
+     * At the end of the process, the user will be removed from the channel.
+     * **Event Data**
+     * - **channel**: The channel for which the invitation was sent.
+     */
+    ON_CONNECTED_USER_INVITATION_DECLINED = "ON_CONNECTED_USER_INVITATION_DECLINED",
+    /**
+     * @eventProperty
+     * This RBEvent is sent when the connected user has accepted an invitation to join a channel.
+     * **Event Data**
+     * - **channel**: The channel for which the invitation was sent.
+     */
+    ON_CONNECTED_USER_INVITATION_ACCEPTED = "ON_CONNECTED_USER_INVITATION_ACCEPTED",
+    /**
+     * @eventProperty
+     * This `RBEvent` event is sent when the connected user has subscribed to a channel.
+     * **Event Data**
+     * - **channel**: The channel concerned.
+     */
+    ON_USER_SUBSCRIPTION = "ON_USER_SUBSCRIPTION",
+    /**
+     * @eventProperty
+     * This RBEvent is sent when the connected user has added to the channel.
+     * **Event Data**
+     * - **channel**: The channel concerned by this event
+     */
+    ON_CONNECTED_USER_ADDED = "ON_CONNECTED_USER_ADDED",
+    /**
+     * @eventProperty
+     * This RBEvent is sent when the role of a member channel has changed.
+     * **Event Data**
+     * - **channel**: The channel concerned by this event
+     */
+    ON_USER_ROLE_UPDATED = "ON_USER_ROLE_UPDATED",
+    /**
+     * @eventProperty
+     * This `RBEvent` event is sent when a new post has been published in the channel.
+     * **Event Data**
+     * - **channel**: The channel in which the new post has been published.
+     * - **post**: The new published post.
+     */
+    ON_CHANNEL_POST_PUBLISHED = "ON_CHANNEL_POST_PUBLISHED",
+    /**
+     * @eventProperty
+     * This `RBEvent` event is sent when a post already published in the channel has been modified.
+     * **Event Data**
+     * - **channel**: The channel in which the post has been modified.
+     * - **post**: The updated post.
+     */
+    ON_CHANNEL_POST_UPDATED = "ON_CHANNEL_POST_UPDATED",
+    /**
+     * @eventProperty
+     * This `RBEvent` event is sent when a post has been removed from the channel.
+     * **Event Data**
+     * - **channel**: The channel in which the post has been removed.
+     * - **postId**: The removed post id.
+     */
+    ON_CHANNEL_POST_REMOVED = "ON_CHANNEL_POST_REMOVED"
+}
+export declare enum ChannelSearchSortBy {
+    /**
+     * The list of channel found must be returned sorted by channel name.
+     */
+    SORT_BY_CHANNEL_NAME = "name",
+    /**
+     * The list of channel found must be returned sorted by channel topic.
+     */
+    SORT_BY_CHANNEL_TOPIC = "topic",
+    /**
+     * The list of channel found must be returned sorted by the number of channel members.
+     */
+    SORT_BY_NB_CHANNEL_MEMBERS = "subscribers_count",
+    /**
+     * The list of channel found must be returned sorted by creation date.
+     */
+    SORT_BY_CHANNEL_CREATION_DATE = "SORT_BY_CHANNEL_CREATION_DATE"
+}
+export declare enum ChannelSearchSortOrder {
+    /**
+     * The list of channel found are sorted in ascending order.
+     */
+    SORT_ASCENDING = "1",
+    /**
+     * The list of channel found are sorted in decreasing order.
+     */
+    SORT_DESCENDING = -1
+}
+/**
+ * The `ChannelCreationData` interface describes the options that can be sent to the createChannel() method
+ * @example
+ * ```ts
+ * const newChannelData = {
+ *      "name": "MyCie internal news",
+ *      "category": "Innovation",
+ *      "topic": "A description of the channel's purpose",
+ *      "visibility" : ChannelVisibility.MY_COMPANY
+ *      "confidentiality" : ChannelConfidentiality.PRIVATE
+ *      "autoProvisionning": true
+ * }
+ * createChannel(newChannelData);
+ * ```
+ */
+export interface ChannelCreationData {
+    /**
+     * The channel name.
+     * It must be unique.
+     */
+    name: string;
+    /**
+     * The channel category
+     */
+    category?: string;
+    /**
+     * The topic of the channel.
+     */
+    topic?: string;
+    /**
+     * The visibility of the channel, i.e. who the channel is intended for.
+     * Once the channel is created, the visibility cannot be changed.
+    //  * If this property is not specified, the visibility will be set to 'MY_COMPANY'.
+     */
+    visibility: ChannelVisibility;
+    /**
+     * In addition to the channel visibility, this allows to refine the channel's audience.
+     * Once the channel is created, the confidentiality cannot be changed.
+    //  * If this property is not specified, the visibility will be set to 'PUBLIC'.
+     */
+    confidentiality: ChannelConfidentiality;
+    /**
+     * Automatically adds all users in my company as channel members.
+     * The ability for a user to create a channel with this option enabled is subject to user right managed by the Company Administrator.
+     * The role "all_company_channels_admin" must be assigned to the user who wants to create this type of channel.
+     * Note that this option is authorized only if the channel visibility is set to 'company' and its confidentiality set to 'closed'.
+     * Default value is FALSE.
+     */
+    addAllCompanyUsers?: boolean;
+    /**
+     * Maximum number of posts to keep in the channel.
+     * The maximum value is 100 and the default is 30.
+     */
+    maxPost?: number;
+}
+export interface ChannelSearchOptions {
+    /**
+     * Search on channel name, in a case-insensitive way.
+     * By default no search will be done on this field.
+     */
+    name?: string;
+    /**
+     * Search on channel topic, in a case-insensitive
+     * By default no search will be done on this field.
+     */
+    topic?: string;
+    /**
+     * Search for channels belonging to one of the categories specified in the list.
+     * The categories will be used in a case-sensitive way.
+     * By default all defined category will be included.
+     */
+    category?: string[];
+    /**
+     * Search for channels that do not belong to any of the categories specified in the list.
+     * The categories will be used in a case-sensitive way.
+     * By default no category will be excluded.
+     */
+    excludedCategory?: string[];
+    /**
+     * Search for channels to which the connected user has subscribed or not.
+     * By default all channels found will be returned regardless of the connected user's subscription status.
+     */
+    subscribed?: boolean;
+    /**
+     * The number of results to return.
+     * Limit value must be in range [1..100]. Default value is 50.
+     * If the value is not in the authorized range, the request will be rejected and an error logged.
+     */
+    limit?: number;
+    /**
+     * The position of the first found channel to retrieve
+     * If no offset is specified, the returned results will start from the first channel found.
+     * If the offset is greater than the total number of results, none are returned.
+     */
+    offset?: number;
+    /**
+     * Sort the list of channels found according to a specified field.
+     * By default, the channels are sorted by channel name.
+     */
+    sortField?: ChannelSearchSortBy;
+    /**
+     * Sort order of the list of channels found.
+     * By default, the results are sorted in ascending order.
+     */
+    sortOrder?: ChannelSearchSortOrder;
+}
+/**
+ * @internal
+ * List of data provided as the result of the 'getUsers' API.
+ */
+export interface ChannelGetUsersResults {
+    /**
+     * The list of users (as User model) matching the search criteria.
+     */
+    ChannelUsers: ChannelUser[];
+    /**
+     * Total number of users who have subscribed to the channel.
+     * Warning: The value returned by the server is not always correct!
+     */
+    total: number;
+}
+/**
+ * The `ChannelService` interface defines the Rainbow SDK ChannelService API
+ */
+export interface ChannelService {
+    /**
+     * Maximum number of posts that can be published in a channel.
+     */
+    readonly maxChannelPosts: number;
+    /**
+     * The aggregated channel should be seen as a mix of posts from the channels the connected user follows, in chronological order.
+     * It is available for the user as soon as the the user's company has subscribed to a dedicated offer including the channel feature.
+     * This virtual is independent of all other channels created by users.
+     * Messages are retrieved via the loadPosts(...) API
+     */
+    aggregatedChannel: ChannelAggregated;
+    /**
+     * Subscribe to updates from the Channel service, all events are of RBEvent<ChannelServiceEvents>
+     * @param callback - The callback function that will be called when events are received
+     * @param eventNames - (optional) A list of event names that the user wants to receive when subscribing (used as filter)
+     */
+    subscribe: (callback: (event: RBEvent<ChannelServiceEvents>) => any, eventNames?: ChannelServiceEvents | ChannelServiceEvents[]) => Subscription;
+    /**
+     * Indicates whether the Channel Service has been initialized or not.
+     * This will be the case when all general information (except messages) on the channels to which
+     * the user is subscribed is available. The same applies to the aggregated channel.
+     * @returns True if the Channel Service has been initialized; False otherwise.
+     */
+    isInitialized: () => boolean;
+    /**
+     * Get all channels to which the user is subscribed.
+     */
+    getChannels: () => Promise<Channel[]>;
+    /**
+     * Get a channel from its identifier.
+     * @param channelId - The channel id
+     */
+    getChannel: (channelId: string) => Promise<Channel | undefined>;
+    /**
+     * Create a new channel.
+     * The user who created a channel will be considered to be the owner of the channel.
+     * The creation of a channel requires the user's company to subscribe to a dedicated offer including this feature.
+     * Returns a Promise with the new created channel.
+     * @param createChannelData - Channel settings that can be specified when it is created.
+     */
+    createChannel: (createChannelData: ChannelCreationData) => Promise<Channel>;
+    /**
+     * Search for channels matching some criteria who are visible to the user i.e. all channels with a 'public'
+     * confidentiality, plus the channels with a 'private' or 'closed' confidentiality the user has a relationship
+     * with (owner, member or invited). What is visible is entirely decided by the server.
+     * At least one search criterion must be specified from options 'name', 'topic', 'category', 'excludedCategory' and 'subscribed'.
+     * You can also specify several criteria, which will be combined during the search.
+     * The way in which the list of channels found is returned can be customised: sorting according to one of the predefined fields and in the specified order.
+     * @param options - Options for refining the channels to be provided.
+     */
+    searchChannels: (options?: ChannelSearchOptions) => Promise<Channel[]>;
+}
+/**
+* @internal
+*/
+export declare class ChannelServiceRB extends Service implements ChannelService {
+    private logger;
+    private authService;
+    private xmppService;
+    private profileService;
+    private i18n;
+    private contactService;
+    private eventService;
+    private errorHelperService;
+    private portalURL;
+    private readonly _started;
+    readonly started: import("rxjs").Observable<boolean>;
+    private channels;
+    channelsList: Channel[];
+    readonly maxChannelPosts: number;
+    aggregatedChannel: ChannelAggregated;
+    private rxSubject;
+    LIST_EVENT_TYPE: {
+        ADD: number;
+        UPDATE: number;
+        REMOVE: number;
+        DELETE: number;
+        SUBSCRIBE: number;
+        UNSUBSCRIBE: number;
+        CREATE: number;
+    };
+    xmppMessageHandler: StropheHandler;
+    xmppManagementHandler: StropheHandler;
+    notificationCounter: number;
+    messageCounter: number;
+    invitationCounter: number;
+    CHANNEL_UPDATE_EVENT: string;
+    CHANNEL_NOTIFICATION_NUMBER_UPDATED: string;
+    CHANNEL_USER_SUBSCRIPTION_EVENT: string;
+    static PAGE_SIZE: number;
+    static getInstance(): ChannelServiceRB;
+    static build(): ChannelServiceRB;
+    protected constructor();
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    reconnect(): Promise<void>;
+    isInitialized(): boolean;
+    private attachXMPPListeners;
+    private removeXMPPListeners;
+    private channelErrorHandler;
+    /**
+     * Allows Channel service events to be sent.
+     * Such events can be listened via channelService.subscribe() API
+     * @param name - the name of the event
+     * @param data - optionally, data associated with the event to be sent (as an object)
+     */
+    sendEvent(name: ChannelServiceEvents, data?: any): void;
+    /**
+     * Subscribe to updates from the Channel service, all events are of RBEvent<ChannelServiceEvents>
+     * @param callback - The callback function that will be called when events are received
+     * @param eventNames - (optional) A list of event names that the user wants to receive when subscribing (used as filter)
+     */
+    subscribe(callback: (event: RBEvent<ChannelServiceEvents>) => any, eventNames?: ChannelServiceEvents | ChannelServiceEvents[]): Subscription;
+    private onChannelMessageReceived;
+    private onChannelManagementReceived;
+    /**
+     * Handle the reception of a new message in the channel or the update of an existing one.
+     * @param item - The id of the channel for which the post has been deleted
+     */
+    private onMessagePublished;
+    /**
+     * Remove a post from the channel following an XMPP notification
+     * @param channelId - The id of the channel for which the post has been deleted
+     * @param messageId - The id of the message
+     */
+    private onMessageRetracted;
+    /**
+     * Update an existing message following an XMPP notification
+     * @param update - The information elements associated to the updated message
+     */
+    private onMessageAppreciationUpdated;
+    private onAddToChannel;
+    private onUpdateToChannel;
+    /**
+     * User removed from the channel in the following scenarios
+     * - The channel owner removes the user from the
+     *   whether it is still being invited or is already a member of the channel.
+     * - The user declines an invitation.
+     */
+    private onRemovedFromChannel;
+    private onSubscribeToChannel;
+    private onUnsubscribeToChannel;
+    private onDeleteChannel;
+    private onUserSubscribeEvent;
+    private onUserUnsubscribeEvent;
+    /**
+     * Get from server all channels to which the user is subscribed or invited.
+     * Retrieved channels are put in cache.
+     * The channel service is considered initialised and therefore operational once this operation is complete.
+     * The CHANNEL_SERVICE_STARTED event is sent as notification.
+     */
+    private getMyChannels;
+    private addChannelToCache;
+    private removeChannelFromCache;
+    /**
+     * Get a channel from internal cache only.
+     */
+    private getChannelFromCache;
+    /**
+     * Retrieves from server messages from the aggregated channel
+     * @param maxMessages - Number of posts to retrive from this channel.
+     * @param beforeDate - The posts must be prior to the specified timestamp (ISO 8601 format)
+     * @param afterDate - The posts must occur after the specified timestamp (ISO 8601 format).
+     */
+    private getAggregatedChannelPosts;
+    /**
+     * Get a specific message (Post) from a given channel
+     * @param channelId - The id of the channel
+     * @param messageId - The id of the message
+     */
+    private getChannelMessage;
+    /**
+     * Get from cache a specific message (Post) from the aggregate Channel (global news feed).
+     * @param messageId - The id of the message
+     */
+    private getAggregateChannelMessage;
+    /**
+     * Get posts from a either a specific channel or the aggregated channel.
+     * @param channel - The channel instance
+     * @param beforeDate - The posts must be prior to the specified timestamp (ISO 8601 format)
+     */
+    private getChannelMessages;
+    /**
+     * Retrieves the 10 most recent messages from the aggregated channel.
+     * The channel has been reset, i.e. all existing messages have been deleted.
+     */
+    private retrieveLatests;
+    /**
+     * Update of the Channel avatar
+     * @param channelId - The id of the channel for which the avatar has been updated
+     * @param avatar - The new channel avatar
+     */
+    private onAvatarChange;
+    private updateNotificationCounter;
+    private decrementInvitationCounter;
+    private chewReceivedItems;
+    private updateChannelsList;
+    /**
+     * Update the channel general settings
+     * Only the following settings are allowed to be modified: name, category, topic, max number of posts
+     * @param channel - The channel to be updated.
+     * @param channelSettings - The settings to be updated in the channel
+     */
+    setSettings(channel: Channel, channelSettings: ChannelSettings): Promise<Channel>;
+    /**
+     * Upload avatar to a channel and resize it to avatarSize
+     * @param channel -  The channel for which the custom avatar will be set
+     * @param avatar - The image to be used as the channel's avatar
+     * @param avatarSize - The size of the image (used as width and height) of the image
+     */
+    uploadChannelAvatar(channel: ChannelRB, avatar: any, avatarSize: number): Promise<any>;
+    /**
+     * Delete avatar of a channel
+     * @param channel - The channel for which the custom avatar will be deleted
+     */
+    deleteChannelAvatar(channel: ChannelRB): Promise<any>;
+    /**
+     * Delete the specified channel.
+     * Only the owner of the channel can delete it.
+     * @param channel - The channel to be deleted.
+     */
+    deleteChannel(channel: Channel): Promise<void>;
+    /**
+     * Browse channels w/o category and subscription status; sorted on given field(s).
+     * @param filter - Options for browsing channel.
+     */
+    browseChannels(filter: any): Promise<ChannelRB[]>;
+    /**
+     * Search channel By Name
+     * @param filter - Search filter limited to a pattern associated to the name
+     */
+    findChannels(filter: any): Promise<ChannelRB[]>;
+    /**
+     * Retrieves from the server the specified number of posts for the specified channel.
+     */
+    loadPosts(channel: ChannelRB, nbPosts: number): Promise<ChannelPost[]>;
+    /**
+     * Retrieves from server posts from a specific channel
+     * @param maxPosts - Number of posts to retrive from this channel.
+     * @param beforeDate - The posts must be prior to the specified timestamp (ISO 8601 format)
+     * @param afterDate - The posts must occur after the specified timestamp (ISO 8601 format).
+     */
+    getChannelPosts(channelId: string, maxPosts: number, beforeDate?: Date, afterDate?: Date): Promise<any[]>;
+    /**
+     * Searches for posts in the channel based on their publication date
+     * Please note that retrieved posts will not be considered as loaded, so NOT stored in the call posts cache.
+     */
+    searchPosts(channel: ChannelRB, nbPosts: number, beforeDate?: Date, afterDate?: Date): Promise<ChannelPost[]>;
+    /**
+     * Publish a new post or modify an existing post in the channel
+     * @param channelId - The channel id in which the post will be added
+     * @param itemId - The message id. relevant only when modifying an existing post, empty for a new post publication.
+     * @param type - The message format (Basic, HTML, Markdown).
+     * @param message - The message text.
+     * @param title - The message title.
+     * @param images - Array of image Ids inserted in the post.
+     * @param video - A video element included in the post.
+     * @param attachments - Array of files Ids attached to the post.
+     */
+    publishToChannel(channelId: string, itemId: string, type: string, message: string, title: string, images: any, video: any, attachments: any): Promise<any>;
+    /**
+     * Removes a post from a channel.
+     * @param channel - The channel in which the post will be removed.
+     * @param post - The message to remove.
+     */
+    deleteChannelPost(channel: ChannelRB, post: ChannelMessage): Promise<void>;
+    getChannelNextPage(channel: any, deferLoadNextPageIndex: number, reset?: boolean): Promise<any>;
+    ackMessage(messageId: string): void;
+    /**
+     * Get the users who are members of the channel and/or users invited to join it.
+     * @param channel - The channel from which we're going to retrieve the list of users  (members + invited).
+     * @param options - Options for getting channel users.
+     */
+    getChannelUsers(channel: Channel, options: ChannelGetUsersOptions): Promise<ChannelGetUsersResults>;
+    /**
+     * Search for users matching the given name who are visible to the channel.
+     * Members and/or non-members can be returned.
+     * @param channel - The channel from which we're going to search users.
+     * @param name - The search criterion based on the user's display name.
+     * @param options - Options for refining the users to be provided.
+     */
+    searchUsersByName(channel: Channel, name: string, options: ChannelSearchUsersOptions): Promise<ChannelUser[]>;
+    /**
+     * Update users in the channel. An update operation can be
+     * - Adding one or more users to the channel to the channel
+     * - Updating the role in the channel of one or more users.
+     * - Removing one or more user members from the channel.
+     * @param channel - The channel for which users will be modified.
+     * @param channelUsers - The users to update.
+     * @param channelUsers - The new role of the users to update.
+     *                       A role with the value 'none' means that a user must be removed from the channel.
+     */
+    updateUsers(channel: ChannelRB, channelUsers: ChannelUser[], role: ChannelUserRole): Promise<any>;
+    /**
+     * Remove all users from A CHANNEL
+     * @param channelId - The channel id
+     */
+    removeAllUsersFromChannel(channelId: string): Promise<any>;
+    /**
+     * Subscribe to a specified channel
+     * @param channel - The channel that the user wants to subscribe.
+     */
+    subscribeToChannel(channel: ChannelRB): Promise<void>;
+    /**
+     * Unsubscribe to a specified channel
+     * @param channel - The channel that the user wants to subscribe.
+     */
+    unsubscribeToChannel(channel: ChannelRB): Promise<void>;
+    removeUnsubscribedChannelFromCache(channelId: string): void;
+    /**
+     * Accept an invitation to join the specified channel.
+     * @param channel - The channel that the user accepts to join.
+     */
+    acceptInvitation(channel: Channel): Promise<void>;
+    /**
+     * Decline invitation to join the specified channel.
+     * @param channel - The channel that the user declines to join.
+     */
+    declineInvitation(channel: Channel): Promise<void>;
+    /**
+     * For Notification Center
+     */
+    getChannelInvitations(): Channel[];
+    muteChannel(channel: ChannelRB): Promise<void>;
+    unmuteChannel(channel: ChannelRB): Promise<void>;
+    /**
+     * Update a user reaction to a post on a channel.
+     * This includes adding, updating and removing a reaction.
+     * @param channel - The channel in which the post was published.
+     * @param post - The message for which the reaction is to be changed.
+     * @param reaction - The user's new reaction.
+     */
+    reactToPost(channel: Channel, post: ChannelMessage, reaction: ChannelPostReaction): Promise<any>;
+    getChannelMessageReactions(channelMessage: ChannelMessage, reaction: string): Promise<any[]>;
+    /**
+     * Get all user reactions or a specific reaction to the current message on the channel.
+     * @param post - The message for which the reaction is to be changed.
+     * @param reaction - Optional filter by reaction type. If no filter is specified, all reactions will be returned.
+     */
+    getPostUserReactions(post: ChannelMessage, reaction?: ChannelPostReaction): Promise<ChannelPostUserReactions[]>;
+    addComment(channel: ChannelRB, channelMessage: ChannelMessage, message: string): Promise<void>;
+    getComments(channel: ChannelRB, channelMessage: ChannelMessage): Promise<void>;
+    incrementMessagesCounter(): void;
+    decrementMessagesCounter(): void;
+    incrementInvitationCounter(): void;
+    /**
+     * Create a new channel.
+     * The user who created a channel will be considered to be the owner of the channel.
+     * The creation of a channel requires the user's company to subscribe to a dedicated offer including this feature.
+     * Returns a Promise with the new created channel.
+     * @param createChannelData - Channel settings that can be specified when it is created.
+     */
+    createChannel(createChannelData: ChannelCreationData): Promise<Channel>;
+    /**
+     * Get all channels to which the user is subscribed.
+     */
+    getChannels(): Promise<Channel[]>;
+    /**
+     * Get from server a channel from its identifier.
+     * @param channelId - The channel id
+     */
+    getChannel(channelId: string): Promise<Channel>;
+    /**
+     * Search for channels matching some criteria who are visible to the user i.e.
+     * - All Channels with a 'public' confidentiality.
+     * - Channels with confidentiality 'private' or 'closed' when the user has a relationship with them
+     *   (owner, member or invited). The visibility of these channels is entirely decided by the server.
+     * The user can subscribe (if not already a member) or unsubscribe (if already a member) from the channels returned in the results,
+     * UNLESS it is the owner, or the channel confidentiality is 'closed' (members of the owner's company are
+     * subscribed automatically and cannot unsubscribe).
+     * At least one search criterion must be specified from options 'name', 'topic', 'category', 'excludedCategory' and 'subscribed'.
+     * You can also specify several criteria, which will be combined during the search.
+     * The way in which the list of channels found is returned can be customised: sorting according to one of the predefined fields and in the specified order.
+     * @param options - Options for refining the channels to be provided.
+     */
+    searchChannels(options: ChannelSearchOptions): Promise<Channel[]>;
+}
+//# sourceMappingURL=channel.service.d.ts.map

package/lib/services/channels/channel.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel.service.d.ts","sourceRoot":"","sources":["../../../src/services/channels/channel.service.ts"],"names":[],"mappings":"AAEA;;GAEG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAIzC,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAC;AAC7K,OAAO,EAAsC,SAAS,EAAE,sBAAsB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AACtK,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,kDAAkD,CAAC;AAC9G,OAAO,EAAE,cAAc,EAAyC,mBAAmB,EAAE,MAAM,kDAAkD,CAAC;AAO9I,OAAO,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAIlE,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAKhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,WAAW,mBAAmB,CAAC;AAc5C;;;;GAIG;AACH,oBAAY,oBAAoB;IAC5B;;;OAGG;IACH,kBAAkB,uBAAuB;IAEzC;;;;;;OAMG;IACH,qCAAqC,0CAA0C;IAE/E;;;;;;OAMG;IACH,qCAAqC,0CAA0C;IAE/E;;;;;OAKG;IACH,qCAAqC,0CAA0C;IAE/E;;;;;OAKG;IACH,oBAAoB,yBAAyB;IAE7C;;;;;OAKG;IACH,uBAAuB,4BAA4B;IAGnD;;;;;OAKG;IACH,oBAAoB,yBAAyB;IAE7C;;;;;;OAMG;IACH,yBAAyB,8BAA8B;IAEvD;;;;;;OAMG;IACH,uBAAuB,4BAA4B;IAEnD;;;;;;OAMG;IACH,uBAAuB,4BAA4B;CAEtD;AAED,oBAAY,mBAAmB;IAC3B;;OAEG;IACH,oBAAoB,SAAS;IAE7B;;OAEG;IACH,qBAAqB,UAAU;IAE/B;;OAEG;IACH,0BAA0B,sBAAsB;IAEhD;;OAEG;IACH,6BAA6B,kCAAkC;CAClE;AAED,oBAAY,sBAAsB;IAC9B;;OAEG;IACH,cAAc,MAAM;IAEpB;;OAEG;IACH,eAAe,KAAK;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,UAAU,EAAE,iBAAiB,CAAC;IAE9B;;;;OAIG;IACH,eAAe,EAAE,sBAAsB,CAAC;IAExC;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IAEjC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,YAAY,EAAE,WAAW,EAAE,CAAC;IAE5B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAE3B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC;;;;;OAKG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IAErC;;;;OAIG;IACH,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,YAAY,CAAC;IAEjJ;;;;;OAKG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;;;OAMG;IACH,aAAa,EAAE,CAAC,iBAAiB,EAAE,mBAAmB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,oBAAoB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CAC1E;AAED;;EAEE;AACF,qBAAa,gBAAiB,SAAQ,OAAQ,YAAW,cAAc;IAMnE,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,IAAI,CAA0C;IACtD,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,kBAAkB,CAAwD;IAElF,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA8B;IACvD,SAAgB,OAAO,qCAAgC;IAIvD,OAAO,CAAC,QAAQ,CAAW;IACpB,YAAY,EAAE,OAAO,EAAE,CAAM;IAKpC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAwB;IACjD,iBAAiB,EAAE,iBAAiB,CAAC;IAI5C,OAAO,CAAC,SAAS,CAAwF;IAMlG,eAAe;;;;;;;;MAAwF;IAEvG,kBAAkB,EAAE,cAAc,CAAQ;IAC1C,qBAAqB,EAAE,cAAc,CAAQ;IAC7C,mBAAmB,EAAE,MAAM,CAAK;IAChC,cAAc,EAAE,MAAM,CAAK;IAC3B,iBAAiB,EAAE,MAAM,CAAK;IAE9B,oBAAoB,SAA0B;IAC9C,mCAAmC,SAAyC;IAC5E,+BAA+B,SAAqC;IAE3E,OAAc,SAAS,EAAE,MAAM,CAAM;WAMvB,WAAW,IAAI,gBAAgB;WAI/B,KAAK,IAAI,gBAAgB;IAIvC,SAAS;IAII,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAqCtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAerB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAWhC,aAAa,IAAI,OAAO;IAI/B,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,mBAAmB;IAc3B,OAAO,CAAC,mBAAmB;IAgB3B;;;;;OAKG;IACI,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,IAAI,GAAE,GAAU;IAI7D;;;;OAIG;IACI,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,GAAG,YAAY;YAuCrI,wBAAwB;YAgCxB,2BAA2B;IAiHzC;;;OAGG;YACW,kBAAkB;IA6HhC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IA8B1B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;YA+BtB,cAAc;YAqCd,iBAAiB;IAW/B;;;;;OAKG;YACW,oBAAoB;YAKpB,oBAAoB;YAsCpB,sBAAsB;YAatB,eAAe;IAM7B,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,sBAAsB;IAO9B;;;;;OAKG;YACW,aAAa;IAyC3B,OAAO,CAAC,iBAAiB;YAMX,sBAAsB;IA0BpC;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;;;;OAKG;YACW,yBAAyB;IAwBvC;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAUzB;;;OAGG;IACH,OAAO,CAAC,0BAA0B;IAUlC;;;;OAIG;YACW,kBAAkB;IAwChC;;;OAGG;YACW,eAAe;IA+B7B;;;;OAIG;IACH,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,yBAAyB;IAMjC,OAAO,CAAC,0BAA0B;IASlC,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,kBAAkB;IAa1B;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAiC9F;;;;;OAKG;IACU,mBAAmB,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBnG;;;OAGG;IACU,mBAAmB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IAiBlE;;;;OAIG;IACU,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB3D;;;OAGG;IACU,cAAc,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IA0C9D;;;OAGG;IACU,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IA4C5D;;OAEG;IACU,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IA4DnF;;;;;OAKG;IACU,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAE,IAAW,EAAE,SAAS,GAAE,IAAW,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA6BlI;;;OAGG;IACU,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,IAAW,EAAE,SAAS,GAAE,IAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IA4BtI;;;;;;;;;;OAUG;IACU,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAoCvK;;;;OAIG;IACU,iBAAiB,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc;IAc1D,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,sBAAsB,EAAE,MAAM,EAAE,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAuF5G,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAa1C;;;;OAIG;IACU,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAmEhH;;;;;;OAMG;IACU,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IA4C1H;;;;;;;;;OASG;IACU,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAyB9G;;;OAGG;IACU,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAoBvE;;;OAGG;IACU,kBAAkB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBlE;;;OAGG;IACU,oBAAoB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB7D,kCAAkC,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IA0BlE;;;OAGG;IACU,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB9D;;;OAGG;IACU,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB/D;;OAEG;IACI,qBAAqB,IAAI,OAAO,EAAE;IAQ5B,WAAW,CAAC,OAAO,EAAE,SAAS;IAU9B,aAAa,CAAC,OAAO,EAAE,SAAS;IAc7C;;;;;;OAMG;IACU,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC;IAiBhG,0BAA0B,CAAC,cAAc,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA8CzG;;;;OAIG;IACU,oBAAoB,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAqD/G,UAAU,CAAC,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9F,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BpF,wBAAwB,IAAI,IAAI;IAKhC,wBAAwB,IAAI,IAAI;IAMhC,0BAA0B,IAAI,IAAI;IAazC;;;;;;OAMG;IACU,aAAa,CAAC,iBAAiB,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IA6CpF;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAc9C;;;OAGG;IACU,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgC5D;;;;;;;;;;;;OAYG;IACU,cAAc,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAgEjF"}

package/lib/services/channels/index.d.ts

@@ -0,0 +1,3 @@
+export type { ChannelService } from "./channel.service";
+export { ChannelServiceEvents, ChannelSearchSortBy, ChannelSearchSortOrder, CHANNEL_SVC } from "./channel.service";
+//# sourceMappingURL=index.d.ts.map

package/lib/services/channels/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/channels/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC"}

package/lib/services/citrix/citrix.service.d.ts

@@ -0,0 +1,30 @@
+import { Service } from "../../services/service";
+export declare const CITRIX_SVC = "CitrixService";
+export declare class CitrixService extends Service {
+    private logger;
+    private mainService;
+    private xmppService;
+    private settingsService;
+    private contactService;
+    private deviceManagementService;
+    private webrtcConfigAndUtils;
+    private centralizedService;
+    started: boolean;
+    vdiClientConnected: boolean;
+    citrixSDK: any;
+    private apiOverwrited;
+    private nativeAPIs;
+    private vendorName;
+    static getInstance(): CitrixService;
+    static build(): CitrixService;
+    protected constructor();
+    start(): Promise<void>;
+    stop(): void;
+    private initCitrixSDK;
+    private setWindowAPIs;
+    private overwriteGlobalAPIs;
+    private resetGlobalAPIs;
+    private onConnectionStateChangeEvent;
+    private updatePopoutConfiguration;
+}
+//# sourceMappingURL=citrix.service.d.ts.map