Package com.microsoft.store.partnercenter.customerusers

Interface ICustomerUserCollection

All Superinterfaces:

IEntireEntityCollectionRetrievalOperations<CustomerUser,SeekBasedResourceCollection<CustomerUser>>, IEntityCreateOperations<CustomerUser,CustomerUser>, IPartnerComponent<String>, IPartnerComponentString

All Known Implementing Classes:

CustomerUsersCollectionOperations

public interface ICustomerUserCollection
extends IPartnerComponentString, IEntityCreateOperations<CustomerUser,CustomerUser>, IEntireEntityCollectionRetrievalOperations<CustomerUser,SeekBasedResourceCollection<CustomerUser>>

Represents the behavior of the customers users

Method Summary

Modifier and Type	Method	Description
ICustomerUser	byId(String userId)	Gets a single customer user operations.
CustomerUser	create(CustomerUser newEntity)	Create a new user for the customer.
SeekBasedResourceCollection<CustomerUser>	get()	Retrieves all the customer users.
SeekBasedResourceCollection<CustomerUser>	query(IQuery customerUsersQuery)	Queries users associated to the customer.

Methods inherited from interface com.microsoft.store.partnercenter.IPartnerComponent

getContext, getPartner

Method Details

byId

ICustomerUser byId(String userId)

Gets a single customer user operations.

Parameters:

userId - The user identifier.

Returns:

The customer user operations for the specified user.

query

SeekBasedResourceCollection<CustomerUser> query(IQuery customerUsersQuery)

Queries users associated to the customer. - Count queries are not supported by this operation. - You can set page size, filter and sort option. - You can navigate to other pages by specifying a seek query with the seek operation and the continuation token sent by the previous operation.

Parameters:

customerUsersQuery - A query to apply onto customer users. Check QueryFactory to see how to build queries.

Returns:

The requested customer users.

create

CustomerUser create(CustomerUser newEntity)

Create a new user for the customer.

Specified by:

create in interface IEntityCreateOperations<CustomerUser,CustomerUser>

Parameters:

newEntity - The user object containing details for the new user to be created.

Returns:

User entity

get

SeekBasedResourceCollection<CustomerUser> get()

Retrieves all the customer users.

Specified by:

get in interface IEntireEntityCollectionRetrievalOperations<CustomerUser,SeekBasedResourceCollection<CustomerUser>>

Returns:

All the customer users.