• DiscoveryPayload

    • Contents

    DiscoveryPayload Class

    Represents server discovery data including endpoint URLs and metadata. More...

    Header: #include <DiscoveryPayload>

    Properties

    Public Functions

    DiscoveryPayload(const QJsonObject &json)
    DiscoveryPayload(const QString &name, const QString &serverId, const QString &authEndpoint, const QString &tokenEndpoint, const QString chatEndpoint, const QString healthUrl)
    QString authEndpoint() const
    QString chatEndpoint() const
    QString healthUrl() const
    QString serverId() const
    QString serverName() const
    void setAuthEndpoint(const QString &endpoint)
    void setChatEndpoint(const QString &endpoint)
    void setHealthUrl(const QString &url)
    void setServerId(const QString &serverId)
    void setServerName(const QString &serverName)
    void setTokenEndpoint(const QString &endpoint)
    QString tokenEndpoint() const

    Detailed Description

    DiscoveryPayload encapsulates the fields returned from a discovery server, such as the server name and key endpoint URLs for authentication and messaging.

    Property Documentation

    authEndpoint : QString

    Returns the authentication endpoint URL.

    Access functions:

    QString authEndpoint() const
    void setAuthEndpoint(const QString &endpoint)

    chatEndpoint : QString

    Returns the WebSocket chat endpoint URL.

    Access functions:

    QString chatEndpoint() const
    void setChatEndpoint(const QString &endpoint)

    healthUrl : QString

    Returns the health check endpoint URL.

    Access functions:

    QString healthUrl() const
    void setHealthUrl(const QString &url)

    serverId : QString

    Returns the internal identifier for the server.

    Access functions:

    QString serverId() const
    void setServerId(const QString &serverId)

    serverName : QString

    This property holds the user-facing name of the server.

    Access functions:

    QString serverName() const
    void setServerName(const QString &serverName)

    tokenEndpoint : QString

    Returns the token exchange endpoint URL.

    Access functions:

    QString tokenEndpoint() const
    void setTokenEndpoint(const QString &endpoint)

    Member Function Documentation

    [explicit] DiscoveryPayload::DiscoveryPayload(const QJsonObject &json)

    Constructs a DiscoveryPayload from a JSON object.

    Extracts fields from json including server name, ID, and endpoint URLs.

    DiscoveryPayload::DiscoveryPayload(const QString &name, const QString &serverId, const QString &authEndpoint, const QString &tokenEndpoint, const QString chatEndpoint, const QString healthUrl)

    Constructs a DiscoveryPayload with explicit values.

    name is the display name of the server. serverId is a unique identifier. authEndpoint is the authentication endpoint. tokenEndpoint is the URL for token exchange. chatEndpoint is the URL for WebSocket connection. healthUrl is the endpoint for authentication service health checks.

    void DiscoveryPayload::setAuthEndpoint(const QString &endpoint)

    Sets the authentication endpoint.

    endpoint is the authentication new URL to set.

    Note: Setter function for property authEndpoint.

    See also authEndpoint().

    void DiscoveryPayload::setChatEndpoint(const QString &endpoint)

    Sets the new WebSocket chat endpoint.

    endpoint is the new URL to set.

    Note: Setter function for property chatEndpoint.

    See also chatEndpoint().

    void DiscoveryPayload::setHealthUrl(const QString &url)

    Sets the health check URL.

    url is the new URL to set.

    Note: Setter function for property healthUrl.

    See also healthUrl().

    void DiscoveryPayload::setServerId(const QString &serverId)

    Sets the server's unique identifier.

    serverId is the new ID to assign.

    Note: Setter function for property serverId.

    See also serverId().

    void DiscoveryPayload::setServerName(const QString &serverName)

    Sets the server display name.

    serverName is the new name to set.

    Note: Setter function for property serverName.

    See also serverName().

    void DiscoveryPayload::setTokenEndpoint(const QString &endpoint)

    Sets the token endpoint URL.

    endpoint is the new URL to set.

    Note: Setter function for property tokenEndpoint.

    See also tokenEndpoint().