SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ClientDataResponse

    ClientDataResponse: Message<"soulfire.v1.ClientDataResponse"> & {
        email: string;
        id: string;
        role: UserRole;
        serverInfo?: ServerInfo;
        serverPermissions: GlobalPermissionState[];
        username: string;
    }

    Response containing comprehensive information about the authenticated client and server. This is typically called after authentication to populate the client UI with user details.

    Type Declaration

    • email: string

      The email address associated with the user account.

      from field: string email = 8;

    • id: string

      The unique identifier (UUID) of the authenticated user.

      from field: string id = 6;

    • role: UserRole

      The role assigned to the user (ADMIN or USER), which determines base permission levels.

      from field: soulfire.v1.UserRole role = 7;

    • OptionalserverInfo?: ServerInfo

      Metadata about the server instance the client is connected to.

      from field: soulfire.v1.ServerInfo server_info = 11;

    • serverPermissions: GlobalPermissionState[]

      A complete list of all global permissions and whether they are granted to this user. This allows the client to determine which features/actions are available.

      from field: repeated soulfire.v1.GlobalPermissionState server_permissions = 2;

    • username: string

      The display username of the authenticated user.

      from field: string username = 1;

    from message soulfire.v1.ClientDataResponse

    Settings
    Member Visibility