PFSegmentsServerGetPlayersInSegmentAsync - XBOX Game Development Documentation

Permite paginar por todos los jugadores de un segmento determinado. Esta API crea una instantánea de todos los perfiles de jugador que coinciden con la definición del segmento en el momento de su creación y se mantiene durante el tiempo total de vida en segundos (Total Seconds to Live), actualizando su período de vida con cada uso posterior del Continuation Token. Los perfiles que cambien durante el transcurso de la paginación no se reflejarán en los resultados. Actualmente, esta operación no admite segmentos de pruebas AB. NOTA: Esta API está limitada a 30 llamadas por minuto. Se le devolverá un error si supera este umbral.

Sintaxis

HRESULT PFSegmentsServerGetPlayersInSegmentAsync(  
    PFEntityHandle titleEntityHandle,  
    const PFSegmentsGetPlayersInSegmentRequest* request,  
    XAsyncBlock* async  
)  

Parámetros

titleEntityHandle PFEntityHandle PFEntityHandle para una entidad de título obtenida mediante PFAuthenticationGetEntityWithSecretKeyAsync. request PFSegmentsGetPlayersInSegmentRequest* Objeto de solicitud rellenado. async XAsyncBlock*
Inout XAsyncBlock para la operación asincrónica.

Valor devuelto

Tipo: HRESULT Código de resultado de esta operación de API.

Comentarios

Esta API está disponible en Win32, Linux y macOS. La solicitud inicial debe contener al menos un Segment ID. Las solicitudes posteriores deben contener el Segment ID además del Continuation Token. Si no se envía el Continuation Token, se generará una nueva lista de segmentos de jugadores. Cada vez que se pasa el Continuation Token, se actualiza la duración del tiempo total de vida en segundos (Total Seconds to Live). Si transcurre demasiado tiempo entre solicitudes, hasta el punto de que una solicitud posterior supere el tiempo total de vida en segundos, se devolverá un error y se terminará la paginación. Esta API consume muchos recursos y no debe usarse en escenarios que puedan generar volúmenes elevados de solicitudes. Solo se debe realizar una solicitud a esta API a la vez por título. Las solicitudes simultáneas a la API pueden rechazarse con el error APIConcurrentRequestLimitExceeded. Vea también ServerGetAllSegmentsAsync. Cuando se complete la tarea asincrónica, llame a PFSegmentsServerGetPlayersInSegmentGetResultSize y a PFSegmentsServerGetPlayersInSegmentGetResult para obtener el resultado.

Requisitos

Encabezado: PFSegments.h

Consulte también

Miembros de PFSegments

​Sintaxis

​Parámetros

​Valor devuelto

​Comentarios

​Requisitos

​Consulte también