Interface EndpointManager

EndpointManager provides publicly accessible URLs that can be used to contact your Scrypted Plugin.

Hierarchy

  • EndpointManager

Methods

  • Get an URL pathname that can be accessed on your local network or cloud while authenticated. This is an absolute path that requires cookie authentication, and generally used only in browser contexts.

    Returns Promise<string>

  • Get an URL pathname that can be accessed on your local network or cloud while authenticated. This is an absolute path that requires cookie authentication, and generally used only in browser contexts.

    Parameters

    • Optional nativeId: string

    Returns Promise<string>

  • Get an URL that can only be accessed on your local network by anyone with the link. HTTP requests and responses are without any encryption. Plugin implementation is responsible for authentication.

    Returns Promise<string>

  • Get an URL that can only be accessed on your local network by anyone with the link. HTTP requests and responses are without any encryption. Plugin implementation is responsible for authentication.

    Parameters

    • Optional nativeId: string

    Returns Promise<string>

  • Get an URL that can be externally accessed by anyone with the link. Plugin implementation is responsible for authentication.

    Returns Promise<string>

  • Get an URL that can be externally accessed by anyone with the link. Plugin implementation is responsible for authentication.

    Parameters

    • Optional nativeId: string

    Returns Promise<string>

  • Get an URL that can only be accessed on your local network by anyone with the link. HTTP requests and responses are over SSL with a self signed certificate. Plugin implementation is responsible for authentication.

    Returns Promise<string>

  • Get an URL that can only be accessed on your local network by anyone with the link. HTTP requests and responses are over SSL with a self signed certificate. Plugin implementation is responsible for authentication.

    Parameters

    • Optional nativeId: string

    Returns Promise<string>

  • Get an URL that can be used to send a push message to the client. This differs from a cloud endpoint, in that, the Plugin does not send a response back. Plugin implementation is responsible for authentication.

    Returns Promise<string>

  • Get an URL that can be used to send a push message to the client. This differs from a cloud endpoint, in that, the Plugin does not send a response back. Plugin implementation is responsible for authentication.

    Parameters

    • Optional nativeId: string

    Returns Promise<string>

  • Deliver a push notification to the system.

    Parameters

    Returns Promise<void>

Generated using TypeDoc