ICustomerUserCollection Interface

Package:

com.microsoft.store.partnercenter.customerusers

Maven Artifact:

com.microsoft.store:partnercenter:1.15.3

Implements

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

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 and Description
abstract ICustomerUser	byId(String userId) Gets a single customer user operations.
abstract CustomerUser	create(CustomerUser newEntity) Create a new user for the customer.
abstract SeekBasedResourceCollection<CustomerUser>	get() Retrieves all the customer users.
abstract SeekBasedResourceCollection<CustomerUser>	query(IQuery customerUsersQuery) Queries users associated to the customer.

Method Details

byId

public abstract ICustomerUser byId(String userId)

Gets a single customer user operations.

Parameters:

userId - The user identifier.

Returns:

The customer user operations for the specified user.

create

public abstract CustomerUser create(CustomerUser newEntity)

Create a new user for the customer.

Parameters:

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

Returns:

User entity

get

public abstract SeekBasedResourceCollection get()

Retrieves all the customer users.

Returns:

All the customer users.

query

public abstract SeekBasedResourceCollection 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.