Class InvitatationsClient

send

• send<I, R, R_O, R_RM, R_RM_U, R_RM_U_UP, R_RM_U_UP_E, O>(fields: I[], args: MutationSendInvitationArgs, option?: InvitationOption<R, R_O, R_RM, R_RM_U, R_RM_U_UP, R_RM_U_UP_E, O>): Promise<Result<InvitationResult<I, R, R_O, R_RM, R_RM_U, R_RM_U_UP, R_RM_U_UP_E, O>>>

• Send an invitatoin.

  client.invitatoins.send(['id'], {
    data: {
      contactFullName: 'joe',
      contactType: ContactType.Email,
      contactInfo: 'example@gmail.com',
      organizationMemberRoleId: 'xxxxxxxxxxxxxxxxxx',
      roomId: 'xxxxxxxxxxxxxxxxxx',
      locale: Enum.Locale.En
    }
  }).then(v => {
    console.log(v)
  })

  If you don't want to send a notificatoin message from classdo, you can use withoutNotificattion flag.

   client.invitatoins.send(['id'], {
    data: {
      contactFullName: 'joe',
      contactType: ContactType.Email,
      contactInfo: 'example@gmail.com',
      organizationMemberRoleId: 'xxxxxxxxxxxxxxxxxx',
      roomId: 'xxxxxxxxxxxxxxxxxx',
      locale: Enum.Locale.En,
      withoutNotification: true
    }
  }).then(v => {
    console.log(v)
  })

  Type parameters

  • I: InvitationKeys

  • R: RoomKeys | null

  • R_O: OrganizationKeys | null

  • R_RM: RoomMemberKeys | null

  • R_RM_U: UserKeys | null

  • R_RM_U_UP: UserProfileKeys | null

  • R_RM_U_UP_E: EmailKeys | null

  • O: OrganizationKeys | null

  Parameters

  • fields: I[]

    Array of Invitation key names. Returns specified fields as result.

  • args: MutationSendInvitationArgs

  • Optional option: InvitationOption<R, R_O, R_RM, R_RM_U, R_RM_U_UP, R_RM_U_UP_E, O>

  Returns Promise<Result<InvitationResult<I, R, R_O, R_RM, R_RM_U, R_RM_U_UP, R_RM_U_UP_E, O>>>