openvibe-sdk/identity

Generated at from openvibe-contracts v0.33.0 and openvibe-sdk v0.5.0.

From types/identity.d.ts (server only). Declarations are shown verbatim.

interface SubjectProjection

export interface SubjectProjection {
    subject: SubjectRef;
    network_user_id?: number;
    network_anon_id?: number;
    username: string;
    display_name: string;
    avatar_url: string | null;
    banned: boolean;
    [field: string]: unknown;
}

type ResolveInput

export type ResolveInput = { subjectId: string } | { system: string; type?: string; id: string | number };

type ResolveBatchInput

export type ResolveBatchInput = { subjectIds: string[] } | { system: string; type?: string; ids: Array<string | number> };

interface IdentityClient

export interface IdentityClient {
    resolve(input: ResolveInput): Promise<SubjectProjection | null>;
    resolveBatch(input: ResolveBatchInput): Promise<Record<string, SubjectProjection | null>>;
}

function createIdentityClient

export declare function createIdentityClient(client: OpenVibeClient, opts?: { baseUrl?: string }): IdentityClient;