Unblu Agent Embedded JS API
    Preparing search index...

    Interface CallNotification

    Notification about an incoming call in a conversation.

    interface CallNotification {
        actions: NotificationAction[];
        body: string;
        callerAvatarUrl?: string;
        callerName: string;
        callId: string;
        callState: CallState;
        callType: CallType;
        closeRequested: Promise<void>;
        conversationId: string;
        groupId?: string;
        imageUrl?: string;
        sticky: boolean;
        title: string;
        type: CALL;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actions body callerAvatarUrl? callerName callId callState callType closeRequested conversationId groupId? imageUrl? sticky title type

    Properties

    actions: NotificationAction[]

    Actions that can be executed on the notification (e.g. accepting or declining a call)

    body

    body: string

    The body of the notification

    callerAvatarUrl?: string

    The avatar URL of the calling person

    callerName: string

    The name of the calling person

    callId: string

    The ID of the call

    callState: CallState

    The state of the call

    callType: CallType

    The type of call

    closeRequested: Promise<void>

    A promise that resolves as soon as a notification is withdrawn and shouldn't be displayed anymore

    conversationId: string

    The ID of the related conversation of the notification

    groupId?: string

    Identifier used to group related notifications of the same type (e.g. message notifications are grouped by conversation ID). For example use it as the tag field in WebNotifications to replace the previous "new message" notification for that conversation.

    https://developer.mozilla.org/en-US/docs/Web/API/Notification/tag

    imageUrl?: string

    An image which can be displayed on the notification

    sticky: boolean

    Defines whether the user should be able to dismiss the notification. If 'true', the notification can't be dismissed.

    title: string

    The title of the notification

    type: CALL

    The type of notification. Used to distinguish between call, message, and other notifications.

    Settings

    Member Visibility

    On This Page

    Properties