PFGroupsInviteToGroupAsync - XBOX Game Development Documentation

Invites a player to join a group

Syntax

HRESULT PFGroupsInviteToGroupAsync(  
    PFEntityHandle entityHandle,  
    const PFGroupsInviteToGroupRequest* request,  
    XAsyncBlock* async  
)  

Parameters

entityHandle PFEntityHandle PFEntityHandle to use for authentication. request PFGroupsInviteToGroupRequest* 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. Invites a player to join a group, if they are not blocked by the group. An optional role can be provided to automatically assign the player to the role if they accept the invitation. By default, if the entity has an application to the group outstanding, this will accept the application instead and return an error indicating such, rather than creating a duplicate invitation to join that will need to be cleaned up later. Returns information about the new invitation or an error indicating an existing application to join was accepted. See also GroupAcceptGroupInvitationAsync, GroupListGroupInvitationsAsync, GroupListMembershipOpportunitiesAsync, GroupRemoveGroupInvitationAsync. When the asynchronous task is complete, call PFGroupsInviteToGroupGetResultSize and PFGroupsInviteToGroupGetResult to get the result.

Requirements

Header: PFGroups.h

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

Syntax

Parameters

Return value

Remarks

Requirements

See also