@gphone/sdk
    Preparing search index...

    Interface Host

    What every SDK host hook goes through once rewired (GPHONE-16 step 3). One Host per app: what it may ask for (permissions), what refuses an undeclared ask (require), and what it can reach once allowed (facets).

    interface Host {
        appId: string;
        facets: Facets;
        permissions: readonly (
            | "account"
            | "admin"
            | "call"
            | "camera"
            | "contacts"
            | "highscores"
            | "location"
            | "mail"
            | "marketplace"
            | "media"
            | "messages"
            | "notifications"
            | "reports"
            | "social"
            | "storage"
            | "app-events"
            | "app-registry"
            | "clock"
            | "devtools"
            | "display"
            | "keybinds"
            | "navigation"
            | "notification-settings"
            | "system-hardware"
            | "theme"
            | "wallpaper"
        )[];
        require(
            needed:
                | "account"
                | "admin"
                | "call"
                | "camera"
                | "contacts"
                | "highscores"
                | "location"
                | "mail"
                | "marketplace"
                | "media"
                | "messages"
                | "notifications"
                | "reports"
                | "social"
                | "storage"
                | "app-events"
                | "app-registry"
                | "clock"
                | "devtools"
                | "display"
                | "keybinds"
                | "navigation"
                | "notification-settings"
                | "system-hardware"
                | "theme"
                | "wallpaper"
                | readonly (
                    | "account"
                    | "admin"
                    | "call"
                    | "camera"
                    | "contacts"
                    | "highscores"
                    | "location"
                    | "mail"
                    | "marketplace"
                    | "media"
                    | "messages"
                    | "notifications"
                    | "reports"
                    | "social"
                    | "storage"
                    | "app-events"
                    | "app-registry"
                    | "clock"
                    | "devtools"
                    | "display"
                    | "keybinds"
                    | "navigation"
                    | "notification-settings"
                    | "system-hardware"
                    | "theme"
                    | "wallpaper"
                )[]
                | null,
            hookName: string,
        ): void;
    }
    Index
    appId facets permissions
    require
    appId: string
    facets: Facets
    permissions: readonly (
        | "account"
        | "admin"
        | "call"
        | "camera"
        | "contacts"
        | "highscores"
        | "location"
        | "mail"
        | "marketplace"
        | "media"
        | "messages"
        | "notifications"
        | "reports"
        | "social"
        | "storage"
        | "app-events"
        | "app-registry"
        | "clock"
        | "devtools"
        | "display"
        | "keybinds"
        | "navigation"
        | "notification-settings"
        | "system-hardware"
        | "theme"
        | "wallpaper"
    )[]

    • Throws AppPermissionError unless every permission in needed is declared. needed: null is a no-op — the hook is one of the implicit ones every app is built out of and is never declared (see sdk/permissions.ts).

      Parameters

      • needed:
            | "account"
            | "admin"
            | "call"
            | "camera"
            | "contacts"
            | "highscores"
            | "location"
            | "mail"
            | "marketplace"
            | "media"
            | "messages"
            | "notifications"
            | "reports"
            | "social"
            | "storage"
            | "app-events"
            | "app-registry"
            | "clock"
            | "devtools"
            | "display"
            | "keybinds"
            | "navigation"
            | "notification-settings"
            | "system-hardware"
            | "theme"
            | "wallpaper"
            | readonly (
                | "account"
                | "admin"
                | "call"
                | "camera"
                | "contacts"
                | "highscores"
                | "location"
                | "mail"
                | "marketplace"
                | "media"
                | "messages"
                | "notifications"
                | "reports"
                | "social"
                | "storage"
                | "app-events"
                | "app-registry"
                | "clock"
                | "devtools"
                | "display"
                | "keybinds"
                | "navigation"
                | "notification-settings"
                | "system-hardware"
                | "theme"
                | "wallpaper"
            )[]
            | null
      • hookName: string

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods