BackendApi.c

Go to the documentation of this file.

/*
===========================================
Do not modify, this script is generated
===========================================
*/


sealed class BackendApi
{
    private void BackendApi();
    private void ~BackendApi();

    string GetErrorCode(int code)
    {
        string result;
 
        if (code == EBackendError.EBERR_OK)
            result = "OK";
        else if (code == EBackendError.EBERR_UNKNOWN)
            result = "Offline";
        else if (code == EBackendError.EBERR_DISABLED)
            result = "Communication Disabled";
        else if (code == EBackendError.EBERR_INVALID_STATE)
            result = "Cannot be called from current state";
        else if (code == EBackendError.EBERR_BUSY)
            result = "Busy processing requests";
        else if (code == EBackendError.EBERR_LOGIN_FAILED)
            result = "Failed to logon";
        else if (code == EBackendError.EBERR_AUTH_FAILED)
            result = "Failed to Authenticate";
        else
            result = " * ";
 
        return result;
    }
 
    [Obsolete("Use GetPlayerIdentityId() instead.")]
    string GetPlayerUID( int iPlayerId ) { return GetPlayerIdentityId(iPlayerId); }
    [Obsolete("Use BackendAuthenticatorApi.GetIdentityId() instead.")]
    string GetLocalIdentityId() { return BackendAuthenticatorApi.GetIdentityId(); }
    [Obsolete("Use BackendAuthenticatorApi.IsAuthenticated() instead.")]
    bool IsAuthenticated() { return BackendAuthenticatorApi.IsAuthenticated(); }
    [Obsolete("Use BackendAuthenticatorApi.IsAuthInProgress() instead.")]
    bool IsAuthInProgress() { return BackendAuthenticatorApi.IsAuthInProgress(); }
    [Obsolete()]
    bool IsLocalPlatformAssigned() { return false; }
    [Obsolete()]
    bool Shutdown() { return false; }

    proto external void SetSessionCallback(DSSessionCallback callback);
    proto external int GetStatusCount();
    proto external ServiceStatusItem GetStatusItem( int iIndex );
    proto external ServiceStatusItem GetMainStatus();
    proto external int GetNewsCount();
    proto external NewsFeedItem GetNewsItem( int iIndex );
    [Obsolete("Will be substitued by Notification Api.")]
    proto external int GetNotifyCount();
    [Obsolete("Will be substitued by Notification Api.")]
    proto external NewsFeedItem GetNotifyItem( int iIndex );
    proto external int GetPopupCount();
    proto external PopupFeedItem GetPopupItem( int iIndex );
    proto external void OnPopupReady(BackendCallback callback);
    proto external void OnNewsReady(BackendCallback callback);
    proto external string GetLinkItem( string linkName );
    proto external bool IsRunning();
    proto external bool IsInitializing();
    proto external bool IsActive();
    proto external void RefreshCommStatus();
    proto external int GetCommTestStatus();
    proto external float GetCommResponseTime();
    proto external float GetCommTimeLastSuccess();
    proto external float GetCommTimeLastFail();
    [Obsolete()]
    proto external void Request( int request, BackendCallback cb, JsonApiStruct dataObject );
    proto external void PlayerCharacterGet( BackendCallback cb, JsonApiStruct dataObject, int iPlayerId );
    proto external void PlayerCharacterUpdateS2S( BackendCallback cb, JsonApiStruct dataObject, int iPlayerId );
    proto external void PlayerDevCharacterUpdate( BackendCallback cb, JsonApiStruct dataObject, int iPlayerId );
    [Obsolete()]
    proto external void PlayerData( JsonApiStruct dataObject, int iPlayerId );
    proto external void SettingsData( string sFileName, JsonApiStruct dataObject );
    proto external void FeedbackMessage( BackendCallback cb, JsonApiStruct dataObject, string message, PixelRawData data = null, int width = 0, int height = 0, int channels = 0, int quality = 0 );
    proto external WorkshopApi GetWorkshop();
    proto external GroupCatalogue GetGroupCatalogue();
    proto external ServerConfigApi GetServerConfigApi();
    proto external BanServiceApi GetBanServiceApi();
    proto external ClientLobbyApi GetClientLobby();
    proto external bool IsListedServerAdmin( int iPlayerId );
    proto external bool IsServerOwner( int iPlayerId );
    proto external SessionStorage GetStorage();
    proto external DSSession GetDSSession();
    [Obsolete()]
    proto external string GetPlayerIdentityId(int iPlayerId);
    [Obsolete()]
    proto external PlatformKind GetPlayerPlatformKind(int iPlayerId);
    [Obsolete()]
    proto external string GetPlayerPlatformId(int iPlayerId);
    proto external owned string GetBackendEnv();
    proto external bool GetRunningDSConfig(DSConfig config);
    proto external bool LoadDSConfig(DSConfig config, string fileName);
    proto external bool SaveDSConfig(DSConfig config, string fileName);
    proto external void SetDefaultIpPort(DSConfig config);
    proto external int GetAvailableConfigs(out notnull array<string> configs);
    proto external int GetAvailableConfigPaths(out notnull array<string> configs);
    proto external void NewSession();
    proto external void SetDebugHandling(int iRequest, EBackendDebugHandling eHandlingType);
}