My Project
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
PlayFab.PlayFabEconomyInstanceAPI Class Reference

API methods for managing the catalog. Inventory manages in-game assets for any given entity. More...

Inheritance diagram for PlayFab.PlayFabEconomyInstanceAPI:
PlayFab.SharedModels.IPlayFabInstanceApi

Public Member Functions

 PlayFabEconomyInstanceAPI (PlayFabAuthenticationContext context)
 
 PlayFabEconomyInstanceAPI (PlayFabApiSettings settings, PlayFabAuthenticationContext context)
 
bool IsEntityLoggedIn ()
 Verify entity login.
 
void ForgetAllCredentials ()
 Clear the Client SessionToken which allows this Client to call API calls requiring login. A new/fresh login will be required after calling this.
 
void CreateDraftItem (CreateDraftItemRequest request, Action< CreateDraftItemResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates a new item in the working catalog using provided metadata.
 
void CreateUploadUrls (CreateUploadUrlsRequest request, Action< CreateUploadUrlsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates one or more upload URLs which can be used by the client to upload raw file data.
 
void DeleteEntityItemReviews (DeleteEntityItemReviewsRequest request, Action< DeleteEntityItemReviewsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.
 
void DeleteItem (DeleteItemRequest request, Action< DeleteItemResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Removes an item from working catalog and all published versions from the public catalog.
 
void GetCatalogConfig (GetCatalogConfigRequest request, Action< GetCatalogConfigResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets the configuration for the catalog.
 
void GetDraftItem (GetDraftItemRequest request, Action< GetDraftItemResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Retrieves an item from the working catalog. This item represents the current working state of the item.
 
void GetDraftItems (GetDraftItemsRequest request, Action< GetDraftItemsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Retrieves a paginated list of the items from the draft catalog.
 
void GetEntityDraftItems (GetEntityDraftItemsRequest request, Action< GetEntityDraftItemsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Retrieves a paginated list of the items from the draft catalog created by the Entity.
 
void GetEntityItemReview (GetEntityItemReviewRequest request, Action< GetEntityItemReviewResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets the submitted review for the specified item by the authenticated entity.
 
void GetItem (GetItemRequest request, Action< GetItemResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Retrieves an item from the public catalog.
 
void GetItemModerationState (GetItemModerationStateRequest request, Action< GetItemModerationStateResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets the moderation state for an item, including the concern category and string reason.
 
void GetItemPublishStatus (GetItemPublishStatusRequest request, Action< GetItemPublishStatusResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets the status of a publish of an item.
 
void GetItemReviews (GetItemReviewsRequest request, Action< GetItemReviewsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Get a paginated set of reviews associated with the specified item.
 
void GetItemReviewSummary (GetItemReviewSummaryRequest request, Action< GetItemReviewSummaryResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Get a summary of all reviews associated with the specified item.
 
void PublishDraftItem (PublishDraftItemRequest request, Action< PublishDraftItemResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Initiates a publish of an item from the working catalog to the public catalog.
 
void ReportItem (ReportItemRequest request, Action< ReportItemResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Submit a report for an item, indicating in what way the item is inappropriate.
 
void ReportItemReview (ReportItemReviewRequest request, Action< ReportItemReviewResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Submit a report for a review.
 
void ReviewItem (ReviewItemRequest request, Action< ReviewItemResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates or updates a review for the specified item.
 
void SearchItems (SearchItemsRequest request, Action< SearchItemsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Executes a search against the public catalog using the provided search parameters and returns a set of paginated results.
 
void SetItemModerationState (SetItemModerationStateRequest request, Action< SetItemModerationStateResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Sets the moderation state for an item, including the concern category and string reason.
 
void SubmitItemReviewVote (SubmitItemReviewVoteRequest request, Action< SubmitItemReviewVoteResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Submit a vote for a review, indicating whether the review was helpful or unhelpful.
 
void TakedownItemReviews (TakedownItemReviewsRequest request, Action< TakedownItemReviewsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Submit a request to takedown one or more reviews.
 
void UpdateCatalogConfig (UpdateCatalogConfigRequest request, Action< UpdateCatalogConfigResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Updates the configuration for the catalog.
 
void UpdateDraftItem (UpdateDraftItemRequest request, Action< UpdateDraftItemResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Update the metadata for an item in the working catalog.
 

Public Attributes

readonly PlayFabApiSettings apiSettings = null
 
readonly PlayFabAuthenticationContext authenticationContext = null
 

Detailed Description

API methods for managing the catalog. Inventory manages in-game assets for any given entity.


The documentation for this class was generated from the following file: