Class ViewerClient

get

• get<V, R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E, OM, OM_U, OM_U_UP, OM_U_UP_E, OM_OMR, OMR, B, BR, BR_UL, BR_UL_U, BR_UL_U_P, BR_UL_U_P_E, BR_UL_R, BR_FUL, BR_TUL>(fields: V[], option?: ViewerOption<R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E, OM, OM_U, OM_U_UP, OM_U_UP_E, OM_OMR, OMR, B, BR, BR_UL, BR_UL_U, BR_UL_U_P, BR_UL_U_P_E, BR_UL_R, BR_FUL, BR_TUL>): Promise<Result<ViewerResult<V, R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E, OM, OM_U, OM_U_UP, OM_U_UP_E, OM_OMR, OMR, B, BR, BR_UL, BR_UL_U, BR_UL_U_P, BR_UL_U_P_E, BR_UL_R, BR_FUL, BR_TUL>>>

• Get viewer.

  client.viewer.get(['id'], { rooms: { fields: ['id', 'name'] }}).then(v => {
    console.log(v)
  })

  Type parameters

  • V: ViewerKeys

  • R: RoomKeys | null

  • R_O: OrganizationKeys | null

  • R_M: RoomMemberKeys | null

  • R_M_U: UserKeys | null

  • R_M_U_UP: UserProfileKeys | null

  • R_M_U_UP_E: EmailKeys | null

  • OM: OrganizationMemberKeys | null

  • OM_U: UserKeys | null

  • OM_U_UP: UserProfileKeys | null

  • OM_U_UP_E: EmailKeys | null

  • OM_OMR: OrganizationMemberRoleKeys | null

  • OMR: OrganizationMemberRoleKeys | null

  • B: BillingKeys | null

  • BR: BillingRecordKeys | null

  • BR_UL: UsageLedgerKeys | null

  • BR_UL_U: UserKeys | null

  • BR_UL_U_P: UserProfileKeys | null

  • BR_UL_U_P_E: EmailKeys | null

  • BR_UL_R: RoomKeys | null

  • BR_FUL: UsageLedgerKeys | null

  • BR_TUL: UsageLedgerKeys | null

  Parameters

  • fields: V[]

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

  • Optional option: ViewerOption<R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E, OM, OM_U, OM_U_UP, OM_U_UP_E, OM_OMR, OMR, B, BR, BR_UL, BR_UL_U, BR_UL_U_P, BR_UL_U_P_E, BR_UL_R, BR_FUL, BR_TUL>

  Returns Promise<Result<ViewerResult<V, R, R_O, R_M, R_M_U, R_M_U_UP, R_M_U_UP_E, OM, OM_U, OM_U_UP, OM_U_UP_E, OM_OMR, OMR, B, BR, BR_UL, BR_UL_U, BR_UL_U_P, BR_UL_U_P_E, BR_UL_R, BR_FUL, BR_TUL>>>