Type alias LogoutSuccess

LogoutSuccess: Msg<{
    agentId: string;
    agentSessionId: string;
    eventType: "AgentDesktopMessage";
    loggedOutBy?: string;
    orgId: string;
    roles?: string[];
    status: string;
    subStatus: string;
    trackingId: string;
    type: "AgentLogoutSuccess";
}>

Response type received when an agent successfully logs out from the system

Type declaration

  • agentId: string

    Unique identifier of the agent

  • agentSessionId: string

    Current session ID of the agent

  • eventType: "AgentDesktopMessage"

    Message type identifier for agent desktop events

  • Optional loggedOutBy?: string

    Identity of who initiated the logout if not the agent themselves

  • orgId: string

    Organization ID the agent belongs to

  • Optional roles?: string[]

    List of roles assigned to the agent

  • status: string

    Current status of the agent (e.g., 'LoggedOut')

  • subStatus: string

    Detailed status information

  • trackingId: string

    Tracking ID for the logout request

  • type: "AgentLogoutSuccess"

    Type identifier for logout success event

Remarks

This type represents the response message sent by the server when an agent successfully logs out. It includes essential details about the logout action and the agent's final state.

Settings

Member Visibility

Theme