Usage restriction

GetBlockStatusAsync

To block users who violated your operating policy from entering the app, call GetBlockStatusAsync() to check whether the currently logged-in user is restricted. If the user is sanctioned, the sanction type, the sanction period, and the notice message to show to the user are returned together.

Registering and releasing sanctioned users is handled only in Usage restriction in the Hive Console. The app only retrieves the restriction status. Implement the screen that shows the notice message and blocks entry to the app based on the result yourself in the app client.

The restriction status is delivered as data in a success response, not as an error. The method call itself succeeds even if the user is sanctioned, so check the Data.IsBlocked value to decide whether to allow entry.

Call this method right after the session is registered through login, just before the user enters the main screens of the app. This method identifies the user with the access token of the current session, so no separate request values are needed.

Note

You can also tell whether the user is sanctioned from Data.IsBlock in the login response. However, the login response does not contain the sanction type, period, or notice message, so to tell the user the reason, you must call this method.

Call parameters

Field name	Type	Required	Description
context	`ApiCallContext`	Optional	Per-call settings object. If omitted, the default values are used.

Call example

AuthGetBlockStatusResult, the object returned by GetBlockStatusAsync(), is divided into success, Outcomes (feature-specific results), and Failure (the call could not be completed). This method does not throw exceptions and delivers every processing result through the returned object, so branch with a switch statement instead of try/catch.

Unity

using Hive.Axyl.Auth;
using Hive.Axyl.Core;
using UnityEngine;

IAuthService auth = HiveCore.Resolve<IAuthService>();

AuthGetBlockStatusResult result = await auth.GetBlockStatusAsync();

switch (result)
{
    case AuthGetBlockStatusResult.Success success when success.Data.IsBlocked:
        // Sanctioned user → show the notice message as is and block entry to the app.
        BlockDetail block = success.Data.Block;
        bool isPermanent = block.EndAt == null;
        Debug.LogWarning($"Usage restriction: {block.Name} / Permanent: {isPermanent}");
        ShowBlockPopup(block.Message);
        break;

    case AuthGetBlockStatusResult.Success:
        // No restriction → continue entering the app.
        break;

    // Handle common failures (network and server errors)
    case AuthGetBlockStatusResult.Failure failure:
        HiveError err = failure.Problem;
        Debug.LogError($"[{err.Code}] {err.Message} (trace: {err.TraceId})");
        break;

    // Safety net: unhandled results and unknown new results (UnknownOutcome)
    default:
        Debug.LogWarning($"Unhandled result: {result.GetType().Name}");
        break;
}

Response data

On success, Data of AuthGetBlockStatusResult.Success contains the result.

Variable name	Type	Required	Description
`Data.IsBlocked`	bool	Required	Whether the user is restricted. If `true`, `Data.Block` contains the details.
`Data.Block`	`BlockDetail`	Optional	Usage restriction details. `null` if there is no restriction.

BlockDetail

Variable name	Type	Required	Description
`Code`	int	Required	Restriction type code in the range 100-999. It is the same value as the code registered in Restriction types in the Hive Console.
`Name`	string	Required	Restriction type name
`Message`	string	Required	Notice message to show to the user. It contains the message requested in the device language or in the language specified with SetLanguage. If the message for that language is empty or the app does not support the language, it contains the message in the app's default language. The app client shows the received value as is.
`StartAt`	`DateTimeOffset`	Required	Restriction start time, in UTC.
`EndAt`	`DateTimeOffset?`	Optional	Restriction end time, in UTC. `null` means a permanent restriction.

Response example