ICustomerCollection Interface

Package:
com.microsoft.store.partnercenter.customers
Maven Artifact:
com.microsoft.store:partnercenter:1.15.3

Implements

IPartnerComponentString IEntireEntityCollectionRetrievalOperations<Customer,SeekBasedResourceCollection<Customer>> IEntityCreateOperations<Customer,Customer>

public interface ICustomerCollection extends IPartnerComponentString, IEntityCreateOperations<Customer,Customer>, IEntireEntityCollectionRetrievalOperations<Customer,SeekBasedResourceCollection<Customer>>

Represents the behavior of the partner customers.

Method Summary

Modifier and Type Method and Description
abstract ICustomer byId(String customerId)

Gets a single customer operations.
abstract SeekBasedResourceCollection<Customer> get()

Retrieves all the partner's customers.
abstract ICustomerRelationshipRequest getRelationshipRequests()

Gets the customer relationship request operations.
abstract ICustomerUsageRecordCollection getUsageRecords()

Gets the customer usage record operations.
abstract SeekBasedResourceCollection<Customer> query(IQuery customersQuery)

Queries customers associated to the partner.

Method Details

byId

public abstract ICustomer byId(String customerId)

Gets a single customer operations.

Parameters:

customerId - The customer identifier.

Returns:

The customer operations.

get

public abstract SeekBasedResourceCollection get()

Retrieves all the partner's customers.

Returns:

The partner's customers.

getRelationshipRequests

public abstract ICustomerRelationshipRequest getRelationshipRequests()

Gets the customer relationship request operations.

Returns:

The customer relationship request operations.

getUsageRecords

public abstract ICustomerUsageRecordCollection getUsageRecords()

Gets the customer usage record operations.

Returns:

The customer usage record operations.

query

public abstract SeekBasedResourceCollection query(IQuery customersQuery)

Queries customers associated to the partner. - Count queries are not supported by this operation. - You can set the page size or filter or do both at the same time. - Sort is not supported. - 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:

customersQuery - A query to apply onto customers. Check QueryFactory to see how to build queries.

Returns:

The requested customers.

Applies to