Class InviteApi

constructor

• new InviteApi(options): InviteApi

• Parameters

  • options: {
        logger: undefined | Logger;
        queries: {
            addProject: ((projectDetails: Pick<ProjectJoinDetails, "projectKey" | "encryptionKeys"> & {
                projectName: string;
            }) => Promise<string>);
            getProjectByInviteId: ((projectInviteId: Readonly<Buffer>) => undefined | {
                projectPublicId: string;
            });
        };
        rpc: LocalPeers;
    }

    • logger: undefined | Logger

    • queries: {
          addProject: ((projectDetails: Pick<ProjectJoinDetails, "projectKey" | "encryptionKeys"> & {
              projectName: string;
          }) => Promise<string>);
          getProjectByInviteId: ((projectInviteId: Readonly<Buffer>) => undefined | {
              projectPublicId: string;
          });
      }

      • addProject: ((projectDetails: Pick<ProjectJoinDetails, "projectKey" | "encryptionKeys"> & {
            projectName: string;
        }) => Promise<string>)

        • • (projectDetails): Promise<string>

          • Parameters

            • projectDetails: Pick<ProjectJoinDetails, "projectKey" | "encryptionKeys"> & {
                  projectName: string;
              }

            Returns Promise<string>

      • getProjectByInviteId: ((projectInviteId: Readonly<Buffer>) => undefined | {
            projectPublicId: string;
        })

        • • (projectInviteId): undefined | {
                projectPublicId: string;
            }

          • Parameters

            • projectInviteId: Readonly<Buffer>

            Returns undefined | {
                projectPublicId: string;
            }

    • rpc: LocalPeers

  Returns InviteApi

rpc

accept

• accept(invite): Promise<string>

• Attempt to accept the invite.

  This can fail if the invitor has canceled the invite or if you cannot connect to the invitor's device.

  If the invite is accepted and you had other invites to the same project, those invites are removed, and the invitors are told that you're already part of this project.

  Parameters

  • invite: Pick<MapBuffers<InviteInternal>, "inviteId">

  Returns Promise<string>

getPending

• getPending(): MapBuffers<InviteInternal>[]

• Returns MapBuffers<InviteInternal>[]

reject

• reject(invite): void

• Parameters

  • invite: Pick<MapBuffers<InviteInternal>, "inviteId">

  Returns void