IOfferCollection Interface

Package:

com.microsoft.store.partnercenter.offers

Maven Artifact:

com.microsoft.store:partnercenter:1.15.3

Implements

IPartnerComponentString

public interface IOfferCollection extends IPartnerComponentString

Encapsulates the basic offers behavior.

Method Summary

Modifier and Type	Method and Description
abstract ICategoryOffersCollection	byCategory(String categoryId) Retrieves the operations that can be applied on offers that belong to an offer category.
abstract IOffer	byId(String offerId) Retrieves the operations tied with a specific offer.
abstract ResourceCollection<Offer>	get() Retrieves all the offers for the provided country.
abstract ResourceCollection<Offer>	get(int offset, int size) Retrieves all the offers for the provided country.

Method Details

byCategory

public abstract ICategoryOffersCollection byCategory(String categoryId)

Retrieves the operations that can be applied on offers that belong to an offer category.

Parameters:

categoryId - The offer category identifier.

Returns:

The category offers operations.

byId

public abstract IOffer byId(String offerId)

Retrieves the operations tied with a specific offer.

Parameters:

offerId - The offer id.

Returns:

The offer operations.

get

public abstract ResourceCollection get()

Retrieves all the offers for the provided country.

Returns:

The offers for the provided country.

get

public abstract ResourceCollection get(int offset, int size)

Retrieves all the offers for the provided country.

Parameters:

offset - The starting index

size - The maximum number of offers to return.

Returns:

The requested segment of the offers for the given country.