Estruturas
| Estrutura | Descrição |
|---|---|
| PFGroupsAcceptGroupApplicationRequest | Modelo de dados de PFGroupsAcceptGroupApplicationRequest. Aceita um convite pendente para ingressar em um grupo se a entidade convidada não estiver bloqueada pelo grupo. Nada é retornado em caso de êxito. |
| PFGroupsAcceptGroupInvitationRequest | Modelo de dados de PFGroupsAcceptGroupInvitationRequest. Aceita um convite pendente para ingressar no grupo se a entidade convidada não estiver bloqueada pelo grupo. Somente a entidade convidada ou um pai em sua cadeia (por exemplo, o título) pode aceitar o convite em nome da entidade convidada. Nada é retornado em caso de êxito. |
| PFGroupsAddMembersRequest | Modelo de dados de PFGroupsAddMembersRequest. Adiciona membros a um grupo ou função. Os membros existentes do grupo serão adicionados a funções dentro do grupo, mas se o usuário ainda não for membro do grupo, somente os solicitantes do título poderão adicioná-lo ao grupo, e os demais deverão usar o sistema de solicitação ou de convite do grupo para adicionar novos membros a um grupo. Não retorna nada se for bem-sucedido. |
| PFGroupsApplyToGroupRequest | Modelo de dados de PFGroupsApplyToGroupRequest. Cria uma solicitação para ingressar em um grupo. Chamar isso enquanto já existe uma solicitação de grupo retornará a mesma solicitação em vez de um erro e não atualizará o tempo antes que a solicitação expire. Por padrão, se a entidade tiver um convite pendente para ingressar no grupo, isso aceitará o convite para ingressar no grupo e retornará um erro indicando isso, em vez de criar uma solicitação de ingresso duplicada que precisará ser limpa posteriormente. Retorna informações sobre a solicitação ou um erro indicando que um convite foi aceito em seu lugar. |
| PFGroupsApplyToGroupResponse | Modelo de dados de PFGroupsApplyToGroupResponse. Descreve uma solicitação para ingressar em um grupo. |
| PFGroupsBlockEntityRequest | Modelo de dados de PFGroupsBlockEntityRequest. Impede que uma lista de entidades ingresse em um grupo. Entidades bloqueadas não podem criar novas solicitações de ingresso, ser convidadas a ingressar, aceitar um convite ou ter uma solicitação aceita. A falha devido ao bloqueio não limpa as solicitações ou convites existentes para o grupo. Nenhum dado é retornado em caso de êxito. |
| PFGroupsChangeMemberRoleRequest | Modelo de dados de PFGroupsChangeMemberRoleRequest. Altera a associação de função de uma lista de entidades de uma função para outra em uma única operação. A função de destino já deve existir. Isso equivale a adicionar as entidades à função de destino e removê-las da função de origem. Não retorna nada se for bem-sucedido. |
| PFGroupsCreateGroupRequest | Modelo de dados de PFGroupsCreateGroupRequest. Cria um novo grupo, bem como as funções de administração e de membro, com base no modelo de grupo de um título. Retorna informações sobre o grupo que foi criado. |
| PFGroupsCreateGroupResponse | Modelo de dados de PFGroupsCreateGroupResponse. |
| PFGroupsCreateGroupRoleRequest | Modelo de dados de PFGroupsCreateGroupRoleRequest. Cria uma nova função em um grupo existente, sem membros. Tanto a ID quanto o nome da função devem ser exclusivos dentro do grupo, mas o nome pode ser igual à ID. A ID da função é definida na criação e não pode ser alterada. Retorna informações sobre a função que foi criada. |
| PFGroupsCreateGroupRoleResponse | Modelo de dados de PFGroupsCreateGroupRoleResponse. |
| PFGroupsDeleteGroupRequest | Modelo de dados de PFGroupsDeleteGroupRequest. Exclui um grupo e todas as funções, convites, solicitações de ingresso e bloqueios associados a ele. A permissão para excluir só é exigida do próprio grupo para executar essa ação. O grupo e os dados não podem ser recuperados depois de removidos, mas todos os relatórios de abuso sobre o grupo permanecerão. Nenhum dado é retornado em caso de êxito. |
| PFGroupsDeleteRoleRequest | Modelo de dados de PFGroupsDeleteRoleRequest. Retorna informações sobre a função. |
| PFGroupsEntityMemberRole | Modelo de dados de PFGroupsEntityMemberRole. |
| PFGroupsEntityWithLineage | Modelo de dados de PFGroupsEntityWithLineage. Classe wrapper de entidade que contém a chave da entidade e as entidades que compõem a linhagem da entidade. |
| PFGroupsGetGroupRequest | Modelo de dados de PFGroupsGetGroupRequest. Retorna a ID, o nome, a lista de funções e outras informações não relacionadas à associação sobre um grupo. |
| PFGroupsGetGroupResponse | Modelo de dados de PFGroupsGetGroupResponse. |
| PFGroupsGroupApplication | Modelo de dados de PFGroupsGroupApplication. Descreve uma solicitação para ingressar em um grupo. |
| PFGroupsGroupBlock | Modelo de dados de PFGroupsGroupBlock. Descreve uma entidade que está impedida de ingressar em um grupo. |
| PFGroupsGroupInvitation | Modelo de dados de PFGroupsGroupInvitation. Descreve um convite para um grupo. |
| PFGroupsGroupRole | Modelo de dados de PFGroupsGroupRole. Descreve uma função de grupo. |
| PFGroupsGroupWithRoles | Modelo de dados de PFGroupsGroupWithRoles. Descreve um grupo e as funções que ele contém. |
| PFGroupsInviteToGroupRequest | Modelo de dados de PFGroupsInviteToGroupRequest. Convida um jogador para ingressar em um grupo, se ele não estiver bloqueado pelo grupo. Uma função opcional pode ser fornecida para atribuir automaticamente o jogador à função se ele aceitar o convite. Por padrão, se a entidade tiver uma solicitação pendente para o grupo, isso aceitará a solicitação e retornará um erro indicando isso, em vez de criar um convite de ingresso duplicado que precisará ser limpo posteriormente. Retorna informações sobre o novo convite ou um erro indicando que uma solicitação de ingresso existente foi aceita. |
| PFGroupsInviteToGroupResponse | Modelo de dados de PFGroupsInviteToGroupResponse. Descreve um convite para um grupo. |
| PFGroupsIsMemberRequest | Modelo de dados de PFGroupsIsMemberRequest. Verifica se uma entidade é membro de um grupo ou de uma função dentro do grupo. É retornado um resultado indicando se a entidade é membro do grupo ou um erro de permissão se o chamador não tiver permissão para ler a lista de membros do grupo. |
| PFGroupsIsMemberResponse | Modelo de dados de PFGroupsIsMemberResponse. |
| PFGroupsListGroupApplicationsRequest | Modelo de dados de PFGroupsListGroupApplicationsRequest. Lista todas as solicitações pendentes para ingressar em um grupo. Retorna uma lista de todas as solicitações de ingresso, bem como quando a solicitação expirará. Para obter as solicitações de grupo de uma entidade específica, use ListMembershipOpportunities. |
| PFGroupsListGroupApplicationsResponse | Modelo de dados de PFGroupsListGroupApplicationsResponse. |
| PFGroupsListGroupBlocksRequest | Modelo de dados de PFGroupsListGroupBlocksRequest. Lista todas as entidades impedidas de ingressar em um grupo. Uma lista de entidades bloqueadas é retornada. |
| PFGroupsListGroupBlocksResponse | Modelo de dados de PFGroupsListGroupBlocksResponse. |
| PFGroupsListGroupInvitationsRequest | Modelo de dados de PFGroupsListGroupInvitationsRequest. Lista todos os convites pendentes de um grupo. Retorna uma lista de entidades que foram convidadas, bem como quando o convite expirará. Para obter os convites de grupo de uma entidade específica, use ListMembershipOpportunities. |
| PFGroupsListGroupInvitationsResponse | Modelo de dados de PFGroupsListGroupInvitationsResponse. |
| PFGroupsListGroupMembersRequest | Modelo de dados de PFGroupsListGroupMembersRequest. Obtém uma lista de membros e das funções às quais eles pertencem dentro do grupo. Se o chamador não tiver permissão para exibir a função e o membro não estiver em nenhuma outra função, o membro não será exibido. Retorna uma lista de entidades que são membros do grupo. |
| PFGroupsListGroupMembersResponse | Modelo de dados de PFGroupsListGroupMembersResponse. |
| PFGroupsListMembershipOpportunitiesRequest | Modelo de dados de PFGroupsListMembershipOpportunitiesRequest. Lista todas as solicitações de grupo e convites pendentes de uma entidade. Qualquer pessoa pode chamar isso para qualquer entidade, mas os dados só serão retornados para a entidade ou um pai dessa entidade. Para listar convites ou solicitações de um grupo a fim de verificar se um jogador está tentando ingressar, use ListGroupInvitations e ListGroupApplications. |
| PFGroupsListMembershipOpportunitiesResponse | Modelo de dados de PFGroupsListMembershipOpportunitiesResponse. |
| PFGroupsListMembershipRequest | Modelo de dados de PFGroupsListMembershipRequest. Lista os grupos e funções dos quais uma entidade faz parte, verificando se os metadados e as associações de grupo e função devem estar visíveis para o chamador. Se a entidade não estiver em nenhuma função visível para o chamador, o grupo não será retornado nos resultados, mesmo que o chamador tenha permissão para ver que a entidade é membro desse grupo. |
| PFGroupsListMembershipResponse | Modelo de dados de PFGroupsListMembershipResponse. |
| PFGroupsRemoveGroupApplicationRequest | Modelo de dados de PFGroupsRemoveGroupApplicationRequest. Remove uma solicitação existente para ingressar no grupo. Isso é usado tanto para rejeitar uma solicitação quanto para retirar uma solicitação. A entidade solicitante ou um pai em sua cadeia (por exemplo, o título) pode retirar a solicitação, e qualquer chamador com acesso apropriado no grupo pode rejeitar uma solicitação. Nenhum dado é retornado em caso de êxito. |
| PFGroupsRemoveGroupInvitationRequest | Modelo de dados de PFGroupsRemoveGroupInvitationRequest. Remove um convite existente para ingressar no grupo. Isso é usado tanto para rejeitar um convite quanto para cancelar um convite. A entidade convidada ou um pai em sua cadeia (por exemplo, o título) pode rejeitar o convite chamando este método, e qualquer chamador com acesso apropriado no grupo pode cancelar um convite. Nenhum dado é retornado em caso de êxito. |
| PFGroupsRemoveMembersRequest | Modelo de dados de PFGroupsRemoveMembersRequest. Remove membros de um grupo. Um membro sempre pode remover a si mesmo de um grupo, independentemente das permissões. Não retorna nada se for bem-sucedido. |
| PFGroupsUnblockEntityRequest | Modelo de dados de PFGroupsUnblockEntityRequest. Desbloqueia uma lista de entidades para que possam ingressar em um grupo. Nenhum dado é retornado em caso de êxito. |
| PFGroupsUpdateGroupRequest | Modelo de dados de PFGroupsUpdateGroupRequest. Atualiza dados sobre um grupo, como o nome ou a função de membro padrão. Retorna informações sobre se a atualização foi bem-sucedida. Somente os solicitantes do título podem modificar a função de administração de um grupo. |
| PFGroupsUpdateGroupResponse | Modelo de dados de PFGroupsUpdateGroupResponse. |
| PFGroupsUpdateGroupRoleRequest | Modelo de dados de PFGroupsUpdateGroupRoleRequest. Atualiza o nome da função. Retorna informações sobre se a atualização foi bem-sucedida. |
| PFGroupsUpdateGroupRoleResponse | Modelo de dados de PFGroupsUpdateGroupRoleResponse. |