Class StreamClient

src/client.ts:158–1105

 * @class StreamClient
 */
export class StreamClient<StreamFeedGenerics extends DefaultGenerics = DefaultGenerics> {
  baseUrl: string;
  baseAnalyticsUrl: string;
  apiKey: string;
  appId?: string;
  usingApiSecret: boolean;
  apiSecret: string | null;
  userToken: string | null;
  enrichByDefault: boolean;
  options: ClientOptions;
  userId?: string;
  authPayload?: unknown;
  version: string;
  fayeUrl: string;
  group: string;
  expireTokens: boolean;
  location: string;
  fayeClient: Faye.Client<RealTimeMessage<StreamFeedGenerics>> | null;
  browser: boolean;
  node: boolean;
  nodeOptions?: { httpAgent: http.Agent; httpsAgent: https.Agent };

  request: axios.AxiosInstance;
  subscriptions: Record<
    string,
    { fayeSubscription: Faye.Subscription | Promise<Faye.Subscription>; token: string; userId: string }
  >;
  handlers: Record<string, HandlerCallback>;

  currentUser?: StreamUser<StreamFeedGenerics>;
  personalization: Personalization<StreamFeedGenerics>;
  collections: Collections<StreamFeedGenerics>;
  files: StreamFileStore;
  images: StreamImageStore;
  reactions: StreamReaction<StreamFeedGenerics>;
  auditLogs: StreamAuditLogs<StreamFeedGenerics>;

  private _personalizationToken?: string;
  private _collectionsToken?: string;
  private _getOrCreateToken?: string;

  addToMany?: <StreamFeedGenerics extends DefaultGenerics = DefaultGenerics>( // eslint-disable-line no-shadow
    this: StreamClient, // eslint-disable-line no-use-before-define
    activity: StreamFeedGenerics['activityType'],
    feeds: string[],
  ) => Promise<APIResponse>; // eslint-disable-line no-use-before-define
  followMany?: (this: StreamClient, follows: FollowRelation[], activityCopyLimit?: number) => Promise<APIResponse>; // eslint-disable-line no-use-before-define
  unfollowMany?: (this: StreamClient, unfollows: UnfollowRelation[]) => Promise<APIResponse>; // eslint-disable-line no-use-before-define
  createRedirectUrl?: (this: StreamClient, targetUrl: string, userId: string, events: unknown[]) => string; // eslint-disable-line no-use-before-define
  addUsers?: (this: StreamClient, users: StreamUser[], overrideExisting: boolean) => Promise<AddUsersResponse>; // eslint-disable-line no-use-before-define
  getUsers?: (this: StreamClient, ids: string[]) => Promise<GetUsersResponse>; // eslint-disable-line no-use-before-define
  deleteUsers?: (this: StreamClient, ids: string[]) => Promise<string[]>; // eslint-disable-line no-use-before-define
  deleteActivities?: (this: StreamClient, activities: ActivityToDelete[]) => Promise<APIResponse>; // eslint-disable-line no-use-before-define
  deleteReactions?: (this: StreamClient, ids: string[]) => Promise<APIResponse>; // eslint-disable-line no-use-before-define
  exportUserActivitiesAndReactionIDs?: (this: StreamClient, userId: string) => Promise<ExportIDsResponse>; // eslint-disable-line no-use-before-define

  /**
   * Initialize a client