headlessService.initializeSession({ listener: (result: FetchResult<ISession>) => { console.log(result); }, onSuccess: (session: ISession) => { console.log(session); }, onError: (error: unknown) => { console.error(error); }, });
interface IInitializeSession { listener: (result: FetchResult<ISession>) => void; onSuccess?: (session: ISession) => void; onError?: (error: unknown) => void; }
headlessService.fetchOrganization({ listener: (result: FetchResult<IOrganizationEntity>) => { console.log(result); }, onSuccess: (organization: IOrganizationEntity) => { console.log(organization); }, onError: (error: unknown) => { console.error(error); }, });
interface IFetchOrganization { listener: (result: FetchResult<IOrganizationEntity>) => void; onSuccess?: (session: IOrganizationEntity) => void; onError?: (error: unknown) => void; }
headlessService.fetchUnseenCount({ listener: (result: FetchResult<{ count: number }>) => { console.log(result); }, onSuccess: (data: { count: number }) => { console.log(data); }, onError: (error: unknown) => { console.error(error); }, });
interface IFetchUnseenCount { listener: (result: FetchResult<{ count: number }>) => void; onSuccess?: (data: { count: number }) => void; onError?: (error: unknown) => void; }
headlessService.fetchUnreadCount({ listener: (result: FetchResult<{ count: number }>) => { console.log(result); }, onSuccess: (data: { count: number }) => { console.log(data); }, onError: (error: unknown) => { console.error(error); }, });
interface IFetchUnreadCount { listener: (result: FetchResult<{ count: number }>) => void; onSuccess?: (data: { count: number }) => void; onError?: (error: unknown) => void; }
headlessService.listenNotificationReceive({ listener: (message: IMessage) => { console.log(JSON.stringify(message)); }, });
interface IListenNotificationReceive { listener: (message: IMessage) => void; }
headlessService.listenUnseenCountChange({ listener: (unseenCount: number) => { console.log(unseenCount); }, });
interface IListenUnseenCountChanget { listener: (unseenCount: number) => void; }
headlessService.listenUnreadCountChange({ listener: (unreadCount: number) => { console.log(unreadCount); }, });
interface IListenUnreadCountChanget { listener: (unreadCount: number) => void; }
headlessService.fetchNotifications({ listener: (result: FetchResult<IPaginatedResponse<IMessage>>) => { console.log(result); }, onSuccess: (response: IPaginatedResponse<IMessage>) => { console.log( response.data, response.page, response.totalCount, response.pageSize ); }, page: pageNumber, query: { feedIdentifier: "feedId", read: false, seen: true, // payload sent while triggering the workflow payload: { message : "Notification message", type: "product", } }, storeId: "storeId", });
interface IFetchNotifications { page?: number; storeId?: string; query?: IStoreQuery; listener: (result: FetchResult<IPaginatedResponse<IMessage>>) => void; onSuccess?: (messages: IPaginatedResponse<IMessage>) => void; onError?: (error: unknown) => void; }
headlessService.fetchUserPreferences({ listener: (result: FetchResult<IUserPreferenceSettings[]>) => { console.log(result); }, onSuccess: (settings: IUserPreferenceSettings[]) => { console.log(settings); }, onError: (error: unknown) => { console.error(error); }, });
interface IFetchUserPreferences { listener: (result: FetchResult<IUserPreferenceSettings[]>) => void; onSuccess?: (settings: IUserPreferenceSettings[]) => void; onError?: (error: unknown) => void; }
headlessService.updateUserPreferences({ listener: ( result: UpdateResult< IUserPreferenceSettings, unknown, IUpdateUserPreferencesVariables > ) => { console.log(result); }, onSuccess: (settings: IUserPreferenceSettings) => { console.log(settings); }, onError: (error: unknown) => { console.error(error); }, templateId: "templateId", channelType: "SMS", checked: true, });
interface IUpdateUserPreferences { templateId: IUpdateUserPreferencesVariables["templateId"]; channelType: IUpdateUserPreferencesVariables["channelType"]; checked: IUpdateUserPreferencesVariables["checked"]; listener: ( result: UpdateResult< IUserPreferenceSettings, unknown, IUpdateUserPreferencesVariables > ) => void; onSuccess?: (settings: IUserPreferenceSettings) => void; onError?: (error: unknown) => void; }
headlessService.markNotificationsAsRead({ listener: ( result: UpdateResult<IMessage, unknown, { messageId: IMessageId }> ) => { console.log(result); }, onSuccess: (message: IMessage) => { console.log(message); }, onError: (error: unknown) => { console.error(error); }, messageId: ["messageOne", "messageTwo"], });
interface IMarkNotificationsAsRead { messageId: IMessageId; listener: ( result: UpdateResult<IMessage, unknown, { messageId: IMessageId }> ) => void; onSuccess?: (message: IMessage) => void; onError?: (error: unknown) => void; }
headlessService.markNotificationsAsSeen({ listener: ( result: UpdateResult<IMessage, unknown, { messageId: IMessageId }> ) => { console.log(result); }, onSuccess: (message: IMessage) => { console.log(message); }, onError: (error: unknown) => { console.error(error); }, messageId: ["messageOne", "messageTwo"], });
interface IMarkNotificationsAsSeen { messageId: IMessageId; listener: (result: UpdateResult<IMessage, unknown, { messageId: IMessageId }>) => void; onSuccess?: (message: IMessage) => void; onError?: (error: unknown) => void; }
headlessService.markNotificationsAs({ listener: ( result: UpdateResult<IMessage, unknown, { messageId: IMessageId }> ) => { console.log(result); }, onSuccess: (message: IMessage) => { console.log(message); }, onError: (error: unknown) => { console.error(error); }, messageId: ["messageOne", "messageTwo"], mark: { seen: true, read: true }; });
interface IMarkNotificationsAs { messageId: IMessageId; mark: { seen?: boolean; read?: boolean }; listener: ( result: UpdateResult<IMessage, unknown, { messageId: IMessageId }> ) => void; onSuccess?: (message: IMessage) => void; onError?: (error: unknown) => void; }
headlessService.removeNotification({ listener: ( result: UpdateResult<IMessage, unknown, { messageId: string }> ) => { console.log(result); }, onSuccess: (message: IMessage) => { console.log(message); }, onError: (error: unknown) => { console.error(error); }, messageId: "messageOne", });
interface IRemoveNotification { messageId: string; listener: ( result: UpdateResult<IMessage, unknown, { messageId: string }> ) => void; onSuccess?: (message: IMessage) => void; onError?: (error: unknown) => void; }
headlessService.removeNotifications({ listener: ( result: UpdateResult<void, unknown, { messageIds: string[] }> ) => { console.log(result); }, onSuccess: (message: IMessage) => { console.log(message); }, onError: (error: unknown) => { console.error(error); }, messageIds: ["message_id_1", "message_id_2" ], });
interface IRemoveNotification { messageIds: string[]; listener: ( result: UpdateResult<void, unknown, { messageIds: string[] }> ) => void; onSuccess?: (message: IMessage) => void; onError?: (error: unknown) => void; }
feedId
headlessService.removeAllNotifications({ listener: (result: UpdateResult<void, unknown, undefined>) => { console.log(result); }, onSuccess: () => { console.log("success"); }, onError: (error: unknown) => { console.error(error); }, feedId: "feedOne", });
interface IRemoveAllNotifications { feedId?: string; listener: (result: UpdateResult<void, unknown, undefined>) => void; onSuccess?: () => void; onError?: (error: unknown) => void; }
headlessService.updateAction({ listener: ( result: UpdateResult<IMessage, unknown, IUpdateActionVariables> ) => { console.log(result); }, onSuccess: (data: IMessage) => { console.log(data); }, onError: (error: unknown) => { console.error(error); }, messageId: "messageOne", actionButtonType: "primary", status: "done", payload: { abc: "def", }, });
interface IUpdateAction { messageId: IUpdateActionVariables["messageId"]; actionButtonType: IUpdateActionVariables["actionButtonType"]; status: IUpdateActionVariables["status"]; payload?: IUpdateActionVariables["payload"]; listener: ( result: UpdateResult<IMessage, unknown, IUpdateActionVariables> ) => void; onSuccess?: (data: IMessage) => void; onError?: (error: unknown) => void; }
headlessService.markAllMessagesAsRead({ listener: (result: UpdateResult<number, unknown, undefined>) => { console.log(result); }, onSuccess: (count: number) => { console.log(count); }, onError: (error: unknown) => { console.error(error); }, feedId: ["feedOne", "feedTwo"], });
interface IMarkAllMessagesAsRead { listener: (result: UpdateResult<number, unknown, undefined>) => void; onSuccess?: (count: number) => void; onError?: (error: unknown) => void; feedId?: IFeedId; }
headlessService.markAllMessagesAsSeen({ listener: (result: UpdateResult<number, unknown, undefined>) => { console.log(result); }, onSuccess: (count: number) => { console.log(count); }, onError: (error: unknown) => { console.error(error); }, feedId: ["feedOne", "feedTwo"], });
interface IMarkAllMessagesAsSeen { listener: (result: UpdateResult<number, unknown, undefined>) => void; onSuccess?: (count: number) => void; onError?: (error: unknown) => void; feedId?: IFeedId; }
interface IHeadlessServiceOptions { backendUrl?: string; socketUrl?: string; applicationIdentifier: string; subscriberId?: string; subscriberHash?: string; config?: { retry?: number; retryDelay?: number; }; } interface ISession { token: string; profile: ISubscriberJwt; } interface ISubscriberJwt { _id: string; firstName: string; lastName: string; email: string; subscriberId: string; organizationId: string; environmentId: string; aud: "widget_user"; } interface IUpdateUserPreferencesVariables { templateId: string; channelType: string; checked: boolean; } enum ButtonTypeEnum { PRIMARY = "primary", SECONDARY = "secondary", CLICKED = "clicked", } enum MessageActionStatusEnum { PENDING = "pending", DONE = "done", } interface IUpdateActionVariables { messageId: string; actionButtonType: ButtonTypeEnum; status: MessageActionStatusEnum; payload?: Record<string, unknown>; } type FetchResult<T = unknown> = Pick< QueryObserverResult<T>, "data" | "error" | "status" | "isLoading" | "isFetching" | "isError" >; type UpdateResult< TData = unknown, TError = unknown, TVariables = unknown > = Pick< MutationObserverResult<TData, TError, TVariables>, "data" | "error" | "status" | "isLoading" | "isError" >; type IMessageId = string | string[]; type IFeedId = string | string[];
@tanstack/query-core
Was this page helpful?