class MAGES::StubUserAuthentication¶

Overview¶

Stub class for user authentication module. More…

class StubUserAuthentication: public MAGES::UserAuthenticationModule
{
public:
    // properties

    override bool IsLoggedIn;
    override bool HasActiveLicense;
    override string ProductCode;
    override bool OfflineMode;
    override bool RequireLoginAndLicenseBeforeOperationStart;
    override GameObject AuthenticationUI;

    // methods

    override void Shutdown();
    override void Startup();
};

Inherited Members¶

public:
    // properties

    int Version;
    UnityEvent LoggedIn;
    UnityEvent LoggedOut;
    UnityEvent LicenseGranted;
    UnityEvent LicenseRevoked;
    bool IsLoggedIn;
    bool HasActiveLicense;
    bool OfflineMode;
    bool RequireLoginAndLicenseBeforeOperationStart;
    string ProductCode;
    GameObject AuthenticationUI;
    bool IsLoggedIn;
    bool HasActiveLicense;
    UnityEvent LoggedIn;
    UnityEvent LoggedOut;
    UnityEvent LicenseGranted;
    UnityEvent LicenseRevoked;

    // methods

    void Startup();
    void Shutdown();
    virtual void UpdateModule(UpdatePhase updatePhase);
    Task<ResponseStatusCode> LogIn(string username, string password);
    void LogOut();

    Task<ResponseStatusCode> LogInAndRequestLicense(
        string username,
        string password
    );

    Task<ResponseStatusCode> RequestLicense();
    Task<(ResponseStatusCode, User?)> GetUser(bool forceFetchFromServer = false);
    Task<(ResponseStatusCode, License?)> GetActiveLicense(bool forceFetchFromServer = false);

    Task SendRequestAsync(
        HttpRequestMessage msg,
        HttpCompletionOption completionOption,
        CancellationToken cancellationToken
    );

    Task SendRequestAsync(HttpRequestMessage msg);

    Task SendRequestAsync(
        HttpRequestMessage msg,
        HttpCompletionOption completionOption
    );

    Task SendRequestAsync(
        HttpRequestMessage msg,
        CancellationToken cancellationToken
    );

    virtual async Task<ResponseStatusCode> LogIn(string username, string password);
    virtual void LogOut();

    virtual async Task<ResponseStatusCode> LogInAndRequestLicense(
        string username,
        string password
    );

    virtual async Task<ResponseStatusCode> RequestLicense();
    virtual async Task<(ResponseStatusCode, User?)> GetUser(bool forceFetchFromServer = false);
    virtual async Task<(ResponseStatusCode, License?)> GetActiveLicense(bool forceFetchFromServer = false);

    virtual async Task SendRequestAsync(
        HttpRequestMessage msg,
        HttpCompletionOption completionOption,
        CancellationToken cancellationToken
    );

    virtual async Task SendRequestAsync(HttpRequestMessage msg);

    virtual Task SendRequestAsync(
        HttpRequestMessage msg,
        HttpCompletionOption completionOption
    );

    virtual Task SendRequestAsync(
        HttpRequestMessage msg,
        CancellationToken cancellationToken
    );

Detailed Documentation¶

Stub class for user authentication module.

Properties¶

override bool IsLoggedIn

Gets a value indicating whether a user is logged in.

override bool HasActiveLicense

Gets a value indicating whether the user has activated a license.