Class CurrentUser

Index

Constructors

Properties

_AccountName _City _Country _DisplayName _Email _Manager _Peers _SPGroupId _SPGroupTitle _UID _runtimeInstance

Accessors

AccountName City Country DisplayName Email groupId groupTitle isUserDefined Manager Peers UID

Methods

_bruteForceAccountName _getUserData _loadUserData _userUIDParser getInstance

Constructors

constructor

new CurrentUser(accountName?: string): CurrentUser
Parameters
- accountName: string = _spPageContextInfo.userLoginName
Returns CurrentUser
- Defined in sharepoint/user/CurrentUser.abstract.ts:40

Properties

`Protected`_AccountName

_AccountName: string

`Protected`_City

_City: string

`Protected`_Country

_Country: string

`Protected`_DisplayName

_DisplayName: string

`Protected`_Email

_Email: string

`Protected`_Manager

_Manager: string

`Protected`_Peers

_Peers: string[]

`Protected`_SPGroupId

_SPGroupId: number

`Protected`_SPGroupTitle

_SPGroupTitle: string

`Protected`_UID

_UID: string

`Protected` `Static`_runtimeInstance

_runtimeInstance: CurrentUser

Singleton Pattern

Accessors

AccountName

get AccountName(): string
Gets the account name of the current user.

Returns string
The account name as a string.
- Defined in sharepoint/user/CurrentUser.abstract.ts:142

City

get City(): string
Gets the city associated with the current user.

Returns string
The city name as a string.
- Defined in sharepoint/user/CurrentUser.abstract.ts:134

Country

get Country(): string
Gets the country associated with the current user.

Returns string
The country name as a string.
- Defined in sharepoint/user/CurrentUser.abstract.ts:150

DisplayName

get DisplayName(): string
Gets the display name of the current user.

Returns string
The display name as a string.
- Defined in sharepoint/user/CurrentUser.abstract.ts:158

Email

get Email(): string
Gets the email of the current user.

Returns string
The email as a string.
- Defined in sharepoint/user/CurrentUser.abstract.ts:174

groupId

get groupId(): number
Gets the SharePoint group ID of the current user.

Returns number
The group ID as a number.
- Defined in sharepoint/user/CurrentUser.abstract.ts:197

groupTitle

get groupTitle(): string
Gets the SharePoint group title of the current user.

Returns string
The group title as a string.
- Defined in sharepoint/user/CurrentUser.abstract.ts:204

isUserDefined

get isUserDefined(): boolean
Returns boolean
- Defined in sharepoint/user/CurrentUser.abstract.ts:126

Manager

get Manager(): string
Gets the manager of the current user.

Returns string
The manager as a string.
- Defined in sharepoint/user/CurrentUser.abstract.ts:182

Peers

get Peers(): string[]
Gets the peers of the current user.

Returns string[]
An array of peer names.
- Defined in sharepoint/user/CurrentUser.abstract.ts:190

UID

get UID(): string
Gets the UID of the current user.

Returns string
The UID as a string.
- Defined in sharepoint/user/CurrentUser.abstract.ts:166

Methods

`Protected`_bruteForceAccountName

_bruteForceAccountName(_str: string, _tryCount: number): string
This should only be defined in the client environment, due to security compliance
Parameters
- _str: string
- _tryCount: number
Returns string
- Defined in sharepoint/user/CurrentUser.abstract.ts:51

`Protected`_getUserData

_getUserData(accountName: string): void
Parameters
- accountName: string
Returns void
- Defined in sharepoint/user/CurrentUser.abstract.ts:76

`Protected`_loadUserData

_loadUserData(): void
Returns void
- Defined in sharepoint/user/CurrentUser.abstract.ts:63

`Protected`_userUIDParser

_userUIDParser(_str: string): string
This should only be defined in the client environment, due to security compliance
Parameters
- _str: string
Returns string
- Defined in sharepoint/user/CurrentUser.abstract.ts:57

`Static`getInstance

getInstance(): CurrentUser
Returns CurrentUser
- Defined in sharepoint/user/CurrentUser.abstract.ts:36