@triply/triplydb
    Preparing search index...

    Interface ClientConfig

    A TriplyDB instance's own configuration: how it presents itself, and what it allows.

    Returned by App.getInfo. Read it to adapt to the instance you are talking to — which service types it offers, which features are switched on, and what limits it enforces — rather than assuming the defaults of triplydb.com.

    interface ClientConfig {
        apiUrl?: string;
        appLinks?: AppLink[];
        branding: {
            banner?: string;
            description: string;
            logo: string;
            logoBgColor: string;
            logoBgType: LogoBackgroundType;
            logoLg: string;
            name: string;
            tagline: string;
            welcomeMessage: string;
        };
        buildDate: string;
        buildId: string;
        consoleUrl?: string;
        contactEmail: string;
        counts?: { datasets: number; queries: number; stories: number };
        defaultEditorProcessDefinition?: ProcessDefinitionPublic | null;
        elasticServicesEnabled?: boolean;
        enabledOauth?: string[];
        enabledServices: ServiceType[];
        enforceTfa?: EnforceTfaSetting;
        featureToggles?: FeatureToggles;
        globalShaclFunctionDataset?: DatasetInfo;
        jenaServicesEnabled?: boolean;
        legal?: {
            generalTermsUrl?: string;
            latestRequiredConsentUpdate: string;
            privacyPolicyUrl?: string;
        };
        oneActiveSessionOnly?: boolean;
        passwordSignup?: boolean;
        prefixes: Prefixes;
        roles?: RoleDefinition[];
        starterDataset?: DatasetInfo;
        triplydb?: {
            heroTriples?: HeroTriple[];
            numberOfStatements?: number;
            triplydbDemoLink?: string;
            userAssetByteLimit?: number;
            userGraphLimit?: number;
            userStatementLimit?: number;
        };
        version?: string;
        virtuosoServicesEnabled?: boolean;
    }
    Index
    apiUrl? appLinks? branding buildDate buildId consoleUrl? contactEmail counts? defaultEditorProcessDefinition? elasticServicesEnabled? enabledOauth? enabledServices enforceTfa? featureToggles? globalShaclFunctionDataset? jenaServicesEnabled? legal? oneActiveSessionOnly? passwordSignup? prefixes roles? starterDataset? triplydb? version? virtuosoServicesEnabled?
    apiUrl?: string

    Base URL of the API.

    appLinks?: AppLink[]

    Extra links the instance shows in its interface.

    branding: {
        banner?: string;
        description: string;
        logo: string;
        logoBgColor: string;
        logoBgType: LogoBackgroundType;
        logoLg: string;
        name: string;
        tagline: string;
        welcomeMessage: string;
    }

    How the instance presents itself: its name, logo, colours and welcome text.

    buildDate: string

    When the running build was produced.

    buildId: string

    Identifier of the running build, for matching an instance to a release.

    consoleUrl?: string

    Base URL of the web interface, which is where a resource's human-readable page lives.

    contactEmail: string

    Address for support questions about this instance.

    counts?: { datasets: number; queries: number; stories: number }

    How many datasets, queries and stories the requesting account may see.

    defaultEditorProcessDefinition?: ProcessDefinitionPublic | null

    Process definition new datasets get in the editor, unless they override it.

    elasticServicesEnabled?: boolean
    enabledOauth?: string[]

    OAuth providers this instance accepts logins from.

    enabledServices: ServiceType[]

    Service types this instance offers, so creating one of another kind will fail.

    enforceTfa?: EnforceTfaSetting

    Whether two-factor authentication is required, and of whom.

    featureToggles?: FeatureToggles

    Every known feature, each carrying in value whether it is switched on for this instance.

    Total rather than sparse, so a feature's absence is not the signal that it is unavailable — read value rather than testing for the key.

    globalShaclFunctionDataset?: DatasetInfo

    Dataset holding SHACL functions available to every dataset on the instance.

    jenaServicesEnabled?: boolean
    legal?: {
        generalTermsUrl?: string;
        latestRequiredConsentUpdate: string;
        privacyPolicyUrl?: string;
    }

    Policy documents users must consent to, and when that requirement last changed.

    oneActiveSessionOnly?: boolean

    Whether logging in elsewhere ends the previous session.

    passwordSignup?: boolean

    Whether accounts can be created with a password, as opposed to only through OAuth.

    prefixes: Prefixes

    IRI prefix declarations that apply to every dataset on the instance.

    roles?: RoleDefinition[]

    Roles defined on this instance, which memberships and tokens are granted in terms of.

    starterDataset?: DatasetInfo

    Dataset offered to new users as a starting point.

    triplydb?: {
        heroTriples?: HeroTriple[];
        numberOfStatements?: number;
        triplydbDemoLink?: string;
        userAssetByteLimit?: number;
        userGraphLimit?: number;
        userStatementLimit?: number;
    }

    Limits and promotional content that apply to triplydb.com itself. Absent on every other instance.

    version?: string

    The instance's version, calendar-versioned — 26.4.300, not semver.

    Development builds report unset. Compare it with App.isCompatible rather than by hand.

    virtuosoServicesEnabled?: boolean

    Settings

    On This Page
    Properties