Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API to track the state of the item publish.
Syntax
HRESULT PFCatalogPublishDraftItemAsync(
PFEntityHandle entityHandle,
const PFCatalogPublishDraftItemRequest* request,
XAsyncBlock* async
)
Parameters
entityHandle PFEntityHandle
PFEntityHandle to use for authentication.
request PFCatalogPublishDraftItemRequest*
Populated request object.
async XAsyncBlock*
Inout
XAsyncBlock for the async operation.
Return value
Type: HRESULT
Result code for this API operation.
Remarks
This API is available on all platforms. The call kicks off a workflow to publish the item to the public catalog. The Publish Status API should be used to monitor the publish job. Call XAsyncGetStatus to get the status of the operation. If the service call is unsuccessful, the async result will be E_PF_DATABASE_THROUGHPUT_EXCEEDED, E_PF_ITEM_NOT_FOUND or any of the global PlayFab Service errors. See doc page "Handling PlayFab Errors" for more details on error handling.
Requirements
Header: PFCatalog.h