Package com.microsoft.store.partnercenter.offers

Interface IOfferCollection

All Superinterfaces:
IPartnerComponent<String>, IPartnerComponentString
All Known Implementing Classes:
OfferCollectionOperations
public interface IOfferCollection
extends IPartnerComponentString
Encapsulates the basic offers behavior.

  • Method Details

    • byId

      IOffer byId​(String offerId)
      Retrieves the operations tied with a specific offer.
      Parameters:
      offerId - The offer id.
      Returns:
      The offer operations.

    • get

      ResourceCollection<Offer> get()
      Retrieves all the offers for the provided country.
      Returns:
      The offers for the provided country.

    • get

      ResourceCollection<Offer> 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.

    • byCategory

      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.