@kagamidigital/salt-sdk-mirror
    Preparing search index...

    Type Alias Invitation

    An invitation for a user to join a specific organisation. Organisations contain Accounts, but not all accounts will neccessarily be visible to all collaborators of the organisation. You can list invitations by calling Salt.getOrganisationsInvitations, and accept them by calling Salt.acceptOrganisationInvitation.

    type Invitation = {
        _id: string;
        accessLevel: number;
        address: string;
        id: string;
        invitedBy: { address: string; name: string | null } | null;
        organisation: { id: string; name: string };
        organisation_id: string;
    }
    Index

    Properties

    _id accessLevel address id invitedBy organisation organisation_id

    Properties

    _id

    _id: string

    The internal ID of the invitation.

    Use id instead. Will be removed 1 release after v0.0.38

    accessLevel: number

    The access level that this user will have after accepting the invitation

    address: string

    The address this invitation was issued to.

    id: string

    The internal ID of the invitation.

    v0.0.38

    invitedBy: { address: string; name: string | null } | null

    The collaborator who sent the invitation, or null for invitations issued before inviter tracking existed.

    Type Declaration

    • { address: string; name: string | null }
      • address: string

        The address of the collaborator who sent the invitation.

      • name: string | null

        The name of the collaborator, or null if they have not set one.

    • null

    v0.0.38

    organisation: { id: string; name: string }

    The organisation that sent the invitation.

    Type Declaration

    • id: string

      The internal ID of the organisation.

    • name: string

      The name of the organisation.

    v0.0.38

    organisation_id: string

    The ID of the organisation that sent the invitation.

    Use organisation.id instead. Kept for backwards compatibility. Will be removed 1 release after v0.0.38

    Settings

    Member Visibility

    On This Page

    Properties