Interface IUserQueryCollection

IUserQueryCollection

Hierarchy

IBaseResults<UserOData>
UserCollectionMethods
- IUserQueryCollection

Index

Properties

Methods

Properties

Optional done

done: (resolve: (value?: Array<UserOData>) => void) => void

Type declaration

- (resolve: (value?: Array<UserOData>) => void): void
- Parameters
  - resolve: (value?: Array<UserOData>) => void
    - - (value?: Array<UserOData>): void
      - Parameters
        
        Optional value: Array<UserOData>
        
        Returns void
  Returns void

existsFl

existsFl: boolean

True, if the object exists, false otherwise.

nextFl

nextFl: boolean

True, if more items exist.

response

response: string

The response

results

results: Array<UserOData>

Results

Methods

add

add(properties?: UserCreationInformation): IBaseExecution<any>

Inherited from IUserCollection.add
- Defined in lib/SP/entitytypes.d.ts:731
Parameters
- Optional properties: UserCreationInformation
Returns IBaseExecution<any>

getByEmail

getByEmail(emailAddress?: string): IBaseQuery<User, UserOData> & UserCollections & UserMethods

Inherited from IUserCollection.getByEmail
- Defined in lib/SP/entitytypes.d.ts:726
Parameters
- Optional emailAddress: string
Returns IBaseQuery<User, UserOData> & UserCollections & UserMethods

getById

getById(id?: number): IBaseQuery<User, UserOData> & UserCollections & UserMethods

Inherited from IUserCollection.getById
- Defined in lib/SP/entitytypes.d.ts:727
Parameters
- Optional id: number
Returns IBaseQuery<User, UserOData> & UserCollections & UserMethods

getByLoginName

getByLoginName(loginName?: string): IBaseQuery<User, UserOData> & UserCollections & UserMethods

Inherited from IUserCollection.getByLoginName
- Defined in lib/SP/entitytypes.d.ts:728
Parameters
- Optional loginName: string
Returns IBaseQuery<User, UserOData> & UserCollections & UserMethods

next

next(): IBaseCollection<UserOData>

Inherited from IApiMetadataCollection.next
- Defined in lib/base.d.ts:105
Returns the next set of results.

Returns IBaseCollection<UserOData>

removeById

removeById(id?: number): IBaseExecution<any>

Inherited from IUserCollection.removeById
- Defined in lib/SP/entitytypes.d.ts:729
Parameters
- Optional id: number
Returns IBaseExecution<any>

removeByLoginName

removeByLoginName(loginName?: string): IBaseExecution<any>

Inherited from IUserCollection.removeByLoginName
- Defined in lib/SP/entitytypes.d.ts:730
Parameters
- Optional loginName: string
Returns IBaseExecution<any>

stringify

stringify(): string

Inherited from IApiMetadataCollection.stringify
- Defined in lib/base.d.ts:97
Method to stringify the object.

Returns string

Generated using TypeDoc