Type alias MemberScope

MemberScope: {
    id?: string;
    name?: string;
} & {
    actions: ("create" | "write" | "delete" | "updateMetadata" | "signal")[];
    publication?: objectInputType<{
        actions: ZodArray<ZodEffects<ZodEnum<["write", "create", "delete", "updateMetadata", "enable", "disable"]>, "create" | "write" | "delete" | "updateMetadata" | "enable" | "disable", "create" | "write" | "delete" | "updateMetadata" | "enable" | "disable">, "many">;
    }, ZodTypeAny, "passthrough">;
    subscription?: objectInputType<{
        actions: ZodArray<ZodEffects<ZodEnum<["write", "create", "delete"]>, "create" | "write" | "delete", "create" | "write" | "delete">, "many">;
    }, ZodTypeAny, "passthrough">;
} & {
    [k: string]: unknown;
}

Type declaration

  • Optional id?: string

    id (id または name のどちらかが必須 *)

    • id で対象の member を指定
    • '*' を指定することで、すべての member を指定
  • Optional name?: string

    name (id または name のどちらかが必須 *)

    • name で対象の channel を指定
    • '*' を指定することで、すべての member を指定

Type declaration

  • actions: ("create" | "write" | "delete" | "updateMetadata" | "signal")[]

    以下を複数指定可能

    • write: すべて可能
    • create: 入室（入室時に member が作成される）
    • delete: 退室（入室時に member が削除される）
    • signal: シグナリング情報のやり取り (p2p通信を利用する際に必須)
    • updateMetadata: metadata の編集
  • Optional publication?: objectInputType<{
        actions: ZodArray<ZodEffects<ZodEnum<["write", "create", "delete", "updateMetadata", "enable", "disable"]>, "create" | "write" | "delete" | "updateMetadata" | "enable" | "disable", "create" | "write" | "delete" | "updateMetadata" | "enable" | "disable">, "many">;
    }, ZodTypeAny, "passthrough">

    publication リソースに関するオブジェクトを指定

  • Optional subscription?: objectInputType<{
        actions: ZodArray<ZodEffects<ZodEnum<["write", "create", "delete"]>, "create" | "write" | "delete", "create" | "write" | "delete">, "many">;
    }, ZodTypeAny, "passthrough">

    subscription リソースに関するオブジェクトを指定

Type declaration

  • [k: string]: unknown

Settings

Member Visibility

Theme