VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VxSdk::IVxUserInfo Struct Referenceabstract

Represents general information about a user. More...

#include <IVxUserInfo.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 

Public Attributes

char employeeId [64]
 The employee identifier associated with the user. More...
 
char firstName [64]
 The first name of the user. More...
 
char lastName [64]
 The last name of the user. More...
 
char name [64]
 Gets the friendly name, within the domain, of the user. More...
 
char note [1024]
 Supplemental information about the user. More...
 
int phoneNumberSize
 The size of phoneNumbers. More...
 
VxPhoneNumber * phoneNumbers
 The telephone number(s) for the user. More...
 

Protected Member Functions

void Clear ()
 Clears this instance. More...
 

Detailed Description

Represents general information about a user.

Definition at line 12 of file IVxUserInfo.h.

Member Function Documentation

void VxSdk::IVxUserInfo::Clear ( )
inlineprotected

Clears this instance.

Definition at line 54 of file IVxUserInfo.h.

54  {
55  VxZeroArray(this->employeeId);
56  VxZeroArray(this->firstName);
57  VxZeroArray(this->lastName);
58  VxZeroArray(this->name);
59  VxZeroArray(this->note);
60  this->phoneNumberSize = 0;
61  this->phoneNumbers = nullptr;
62  }
VxSdk::IVxUserInfo::lastName
char lastName[64]
The last name of the user.
Definition: IVxUserInfo.h:32
VxSdk::IVxUserInfo::employeeId
char employeeId[64]
The employee identifier associated with the user.
Definition: IVxUserInfo.h:24
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::IVxUserInfo::phoneNumberSize
int phoneNumberSize
The size of phoneNumbers.
Definition: IVxUserInfo.h:44
VxSdk::IVxUserInfo::name
char name[64]
Gets the friendly name, within the domain, of the user.
Definition: IVxUserInfo.h:36
VxSdk::IVxUserInfo::phoneNumbers
VxPhoneNumber * phoneNumbers
The telephone number(s) for the user.
Definition: IVxUserInfo.h:48
VxSdk::IVxUserInfo::note
char note[1024]
Supplemental information about the user.
Definition: IVxUserInfo.h:40
VxSdk::IVxUserInfo::firstName
char firstName[64]
The first name of the user.
Definition: IVxUserInfo.h:28
virtual VxResult::Value VxSdk::IVxUserInfo::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.

Member Data Documentation

char VxSdk::IVxUserInfo::employeeId[64]

The employee identifier associated with the user.

Definition at line 24 of file IVxUserInfo.h.

char VxSdk::IVxUserInfo::firstName[64]

The first name of the user.

Definition at line 28 of file IVxUserInfo.h.

char VxSdk::IVxUserInfo::lastName[64]

The last name of the user.

Definition at line 32 of file IVxUserInfo.h.

char VxSdk::IVxUserInfo::name[64]

Gets the friendly name, within the domain, of the user.

Definition at line 36 of file IVxUserInfo.h.

char VxSdk::IVxUserInfo::note[1024]

Supplemental information about the user.

Definition at line 40 of file IVxUserInfo.h.

VxPhoneNumber* VxSdk::IVxUserInfo::phoneNumbers

The telephone number(s) for the user.

Definition at line 48 of file IVxUserInfo.h.

int VxSdk::IVxUserInfo::phoneNumberSize

The size of phoneNumbers.

Definition at line 44 of file IVxUserInfo.h.

The documentation for this struct was generated from the following file: