Class MemberApi

Hierarchy

TypedEmitter
- MemberApi

Index

Constructors

Methods

assignRole getById getMany invite requestCancelInvite

Constructors

constructor

new MemberApi(opts): MemberApi
Parameters
- opts: {
      coreOwnership: CoreOwnership;
      dataTypes: {
          deviceInfo: Pick<DeviceInfoDataType, "getByDocId" | "getMany">;
          project: Pick<ProjectDataType, "getByDocId">;
      };
      deviceId: string;
      encryptionKeys: EncryptionKeys;
      projectKey: Buffer;
      roles: Roles;
      rpc: LocalPeers;
  }
  - coreOwnership: CoreOwnership
  - dataTypes: {
    deviceInfo: Pick<DeviceInfoDataType, "getByDocId" | "getMany">;
    project: Pick<ProjectDataType, "getByDocId">;
    }
    - deviceInfo: Pick<DeviceInfoDataType, "getByDocId" | "getMany">
    - project: Pick<ProjectDataType, "getByDocId">
  - deviceId: string
    public key of this device as hex string
  - encryptionKeys: EncryptionKeys
  - projectKey: Buffer
  - roles: Roles
  - rpc: LocalPeers
Returns MemberApi
Overrides TypedEmitter.constructor

Methods

assignRole

assignRole(deviceId, roleId): Promise<void>
Parameters
- deviceId: string
- roleId: "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9"
Returns Promise<void>

getById

getById(deviceId): Promise<MemberInfo>
Parameters
- deviceId: string
Returns Promise<MemberInfo>

getMany

getMany(): Promise<MemberInfo[]>
Returns Promise<MemberInfo[]>

invite

invite(deviceId, opts): Promise<"REJECT" | "ACCEPT" | "ALREADY">
Send an invite. Resolves when receiving a response. Rejects if the invite is canceled, or if something else goes wrong.
Parameters
- deviceId: string
- opts: {
      roleDescription: undefined | string;
      roleId: "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9";
      roleName: undefined | string;
  }
  - roleDescription: undefined | string
  - roleId: "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9"
  - roleName: undefined | string
Returns Promise<"REJECT" | "ACCEPT" | "ALREADY">

requestCancelInvite

requestCancelInvite(deviceId): void
Attempt to cancel an outbound invite, if it exists.

No-op if we weren't inviting this device.
Parameters
- deviceId: string
Returns void