Description

Function library that allows access to the Omni User Service via Blueprint.

#include <OmniUserService.h>

Inherits UBlueprintFunctionLibrary.

Methods
static void	OmniGetLoginUser (UObject *WorldContext, FGetLoginOmniUserDelegate InGetUserInfoCallback)
	Retrieves information about the logged in user.

static void	OmniGetUserInfo (UObject *WorldContext, const FString &UserId, FGetOmniUserInfoDelegate InGetUserInfoCallback)
	Retrieves information about the user with the provided user ID.

static void	OmniAccessToken (UObject *WorldContext, FGetAccessTokenDynamicDelegate InGetAccessTokenCallback)
	Retrieves the game-scoped access token of the logged in user.

static void	OmniGetUserFriends (UObject *WorldContext, FGetOmniUserFriendsInfoDelegate InGetUserFriendsCallback)
	Retrieves the first page of user information for the logged in users friends, up to 100 entries.

static void	OmniGetNextUserPage (UObject WorldContext, UOmniUserArray CurrentArray, FGetOmniUserFriendsInfoDelegate InGetUserFriendsCallback)
	Retrieves a subsequent page of user information for the logged in user's friends, up to 100 entries per page.

static void	OmniGetUserRelations (UObject *WorldContext, TArray< FString > UserIds, FGetUserRelationDynamicDelegate InGetUserRelationsCallback)
	Retrieves user relation data for the logged in user and the array of user Ids provided.

static void	OmniLaunchFriendRequestFlow (UObject *WorldContext, const FString &UserId, FLaunchFriendRequestInfoDelegate OnLaunchFriendRequestResultCallback)

static void	OmniEntitlementCheck (UObject *WorldContext, FIsEntitledDynamicDelegate OnEntitlementCheckResultCallback, const FString &EntitlementKey)
	Perform an entitlement check.

Methods

◆ OmniAccessToken()

static void UOmniUserServiceFunctions::OmniAccessToken	(	UObject *	WorldContext,
		FGetAccessTokenDynamicDelegate	InGetAccessTokenCallback
	)

static

Retrieves the game-scoped access token of the logged in user.

Parameters

WorldContext	Reference to the world context.
InGetAccessTokenCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, `FString AccessToken` are parameters.

◆ OmniEntitlementCheck()

static void UOmniUserServiceFunctions::OmniEntitlementCheck	(	UObject *	WorldContext,
		FIsEntitledDynamicDelegate	OnEntitlementCheckResultCallback,
		const FString &	EntitlementKey
	)

static

Perform an entitlement check.

Parameters

WorldContext	Reference to the world context.
OnEntitlementCheckResultCallback	A callback that will be executed when the service has retrieved the information. `bool bIsEntitled`, is the parameter.
EntitlementKey	Entitlement key.

◆ OmniGetLoginUser()

static void UOmniUserServiceFunctions::OmniGetLoginUser	(	UObject *	WorldContext,
		FGetLoginOmniUserDelegate	InGetUserInfoCallback
	)

static

Retrieves information about the logged in user.

Parameters

WorldContext	Reference to the world context.
InGetUserInfoCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniUser* (null in error cases) are parameters.

◆ OmniGetNextUserPage()

static void UOmniUserServiceFunctions::OmniGetNextUserPage	(	UObject *	WorldContext,
		UOmniUserArray *	CurrentArray,
		FGetOmniUserFriendsInfoDelegate	InGetUserFriendsCallback
	)

static

Retrieves a subsequent page of user information for the logged in user's friends, up to 100 entries per page.

Currently returns empty list if no more friends.

Parameters

WorldContext	Reference to the world context.
CurrentArray	The array for which to retrieve the next page of information.
InGetUserFriendsCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniUserArray* (null in error cases) are parameters.

◆ OmniGetUserFriends()

static void UOmniUserServiceFunctions::OmniGetUserFriends	(	UObject *	WorldContext,
		FGetOmniUserFriendsInfoDelegate	InGetUserFriendsCallback
	)

static

Retrieves the first page of user information for the logged in users friends, up to 100 entries.

Parameters

WorldContext	Reference to the world context.
InGetUserFriendsCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniUserArray* (null in error cases) are parameters.

◆ OmniGetUserInfo()

static void UOmniUserServiceFunctions::OmniGetUserInfo	(	UObject *	WorldContext,
		const FString &	UserId,
		FGetOmniUserInfoDelegate	InGetUserInfoCallback
	)

static

Retrieves information about the user with the provided user ID.

Parameters

WorldContext	Reference to the world context.
UserId	The ID of the user to retrieve information about.
InGetUserInfoCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UOmniUser* (null in error cases) are parameters.

◆ OmniGetUserRelations()

static void UOmniUserServiceFunctions::OmniGetUserRelations	(	UObject *	WorldContext,
		TArray< FString >	UserIds,
		FGetUserRelationDynamicDelegate	InGetUserRelationsCallback
	)

static

Retrieves user relation data for the logged in user and the array of user Ids provided.

Parameters

WorldContext	Reference to the world context.
UserIds	The user IDs for each user to gather relation information about.
InGetUserRelationsCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, UUserRelationResult* (null in error cases) are parameters.

◆ OmniLaunchFriendRequestFlow()

static void UOmniUserServiceFunctions::OmniLaunchFriendRequestFlow	(	UObject *	WorldContext,
		const FString &	UserId,
		FLaunchFriendRequestInfoDelegate	OnLaunchFriendRequestResultCallback
	)

static

Launch a dialog to allow the user to send a friend request.

Parameters

WorldContext	Reference to the world context.
UserId	The User Id for the user that the dialog will attempt to send a request to.
OnLaunchFriendRequestResultCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, `bool bSent` are parameters.