Interface ClientConnectionPayload

interface ClientConnectionPayload {
    connectionUrl: string;
    endpointId: string;
    entityType: EntityType;
    isLocalEndpointId: boolean;
    name: string;
    uuid: string;
}

Properties

connectionUrl: string

URL of the Window, View or IFrame at the time of connection to the Channel Provider.

endpointId: string

Unique identifier for a client, because there can be multiple clients at one name/uuid entity.

entityType: EntityType

Indicates if the client belongs to a Window, View or IFrame

isLocalEndpointId: boolean

name: string

The name of the component. Must be unique within the owning application.

uuid: string

Universally unique identifier of the application that owns the component.