Skip to main content

SecretsService

Functions​

SetPublicKeySeed​

</>
SecretsService:SetPublicKeySeed(seed: number) → ()

Sets the public key seed for the cryptography-at-rest scenario

Start​

</>
SecretsService:Start() → ()

Starts the secret service. Should be done via ServiceBag.

PromiseSecret​

</>
SecretsService:PromiseSecret(secretKey: string) → Promise<string>

Promises a secret value

PromiseAllSecrets​

</>
SecretsService:PromiseAllSecrets() → @returnPromise<{string}>

Promises all secret values

ObserveSecret​

</>
SecretsService:ObserveSecret(secretKey: string) → Observable<string>

Observes a secret value

DeleteSecret​

</>
SecretsService:DeleteSecret(secretKey: string) → Promise.Promise<()>

Deletes a secret from the secret store

StoreSecret​

</>
SecretsService:StoreSecret(
secretKey: string,
value: string
) → ()

Stores a secret in the secret store

ClearAllSecrets​

</>
SecretsService:ClearAllSecrets() → Promise<()>

Clears all the secrets stored in the datastore

PromiseSecretKeyNamesList​

</>
SecretsService:PromiseSecretKeyNamesList() → Promise<{string}>

Gets a list of all available secret keys for the game

Show raw api
{
    "functions": [
        {
            "name": "SetPublicKeySeed",
            "desc": "Sets the public key seed for the cryptography-at-rest scenario",
            "params": [
                {
                    "name": "seed",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 43,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the secret service. Should be done via [ServiceBag].",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 55,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        },
        {
            "name": "PromiseSecret",
            "desc": "Promises a secret value",
            "params": [
                {
                    "name": "secretKey",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 68,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        },
        {
            "name": "PromiseAllSecrets",
            "desc": "Promises all secret values",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "@return Promise<{string}>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 92,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        },
        {
            "name": "ObserveSecret",
            "desc": "Observes a secret value",
            "params": [
                {
                    "name": "secretKey",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 117,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        },
        {
            "name": "DeleteSecret",
            "desc": "Deletes a secret from the secret store",
            "params": [
                {
                    "name": "secretKey",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 153,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        },
        {
            "name": "StoreSecret",
            "desc": "Stores a secret in the secret store",
            "params": [
                {
                    "name": "secretKey",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 167,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        },
        {
            "name": "ClearAllSecrets",
            "desc": "Clears all the secrets stored in the datastore",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<()>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 192,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        },
        {
            "name": "PromiseSecretKeyNamesList",
            "desc": "Gets a list of all available secret keys for the game",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<{ string }>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 203,
                "path": "src/secrets/src/Server/SecretsService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SecretsService",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/secrets/src/Server/SecretsService.lua"
    }
}