Interface EndpointManager

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

Hierarchy

EndpointManager

Index

Methods

getAuthenticatedPath getInsecurePublicLocalEndpoint getPublicLocalEndpoint getPublicPushEndpoint getPublicCloudEndpoint getPath getLocalEndpoint getCloudEndpoint getCloudPushEndpoint setLocalAddresses getLocalAddresses setAccessControlAllowOrigin

Methods

getAuthenticatedPath

getAuthenticatedPath(nativeId?: string): Promise<string>
Get an URL pathname for a device that can be accessed with authentication. This is a relative path that can be used in browser sessions.

Deprecated
Parameters
- Optional nativeId: string
Returns Promise<string>

getInsecurePublicLocalEndpoint

getInsecurePublicLocalEndpoint(nativeId?: string): 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.

Deprecated
Parameters
- Optional nativeId: string
Returns Promise<string>

getPublicLocalEndpoint

getPublicLocalEndpoint(nativeId?: string): 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.

Deprecated
Parameters
- Optional nativeId: string
Returns Promise<string>

getPublicPushEndpoint

getPublicPushEndpoint(nativeId?: string): 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.

Deprecated
Parameters
- Optional nativeId: string
Returns Promise<string>

getPublicCloudEndpoint

getPublicCloudEndpoint(nativeId?: string): Promise<string>
Get an URL that can be externally accessed by anyone with the link. Plugin implementation is responsible for authentication.

Deprecated
Parameters
- Optional nativeId: string
Returns Promise<string>

getPath

getPath(nativeId?: string, options?: {
public?: boolean;
}): Promise<string>
Get an URL pathname for a device that can be accessed without authentication. This is a relative path that can be used in browser sessions.
Parameters
- Optional nativeId: string
- Optional options: {
  public?: boolean;
  }
  - Optional public?: boolean
Returns Promise<string>

getLocalEndpoint

getLocalEndpoint(nativeId?: string, options?: {
public?: boolean;
insecure?: boolean;
}): Promise<string>
Get an URL that can only be accessed on your local network by anyone with the link.
Parameters
- Optional nativeId: string
- Optional options: {
  public?: boolean;
  insecure?: boolean;
  }
  - Optional public?: boolean
    
    A public endpoint that does not require authentication with the local Scrypted server.
  - Optional insecure?: boolean
    
    An insecure endpoint served by http, not https.
Returns Promise<string>

getCloudEndpoint

getCloudEndpoint(nativeId?: string, options?: {
public?: boolean;
}): Promise<string>
Get an URL that can be externally accessed by anyone with the link. Plugin implementation is responsible for authentication.

Deprecated
Parameters
- Optional nativeId: string
- Optional options: {
  public?: boolean;
  }
  - Optional public?: boolean
    
    A public endpoint that does not require authentication with the local Scrypted server.
Returns Promise<string>

getCloudPushEndpoint

getCloudPushEndpoint(nativeId?: string): 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.
Parameters
- Optional nativeId: string
Returns Promise<string>

setLocalAddresses

setLocalAddresses(addresses: string[]): Promise<void>
Set the recommended local addresses used by Scrypted plugins that listen for incoming connections.
Parameters
- addresses: string[]
Returns Promise<void>

getLocalAddresses

getLocalAddresses(): Promise<string[]>
Get the recommended local addresess used by Scrypted plugins that listen for incoming connections.

Returns Promise<string[]>

setAccessControlAllowOrigin

setAccessControlAllowOrigin(options: EndpointAccessControlAllowOrigin): Promise<void>
Set the allowed origins for an endpoint for cross origin requests. I.e. 'https://example.com' would allow cross origin requests from that origin. For security, this setting will not persist between plugin reloads and must be called per desired origin after plugin startup.
Parameters
- options: EndpointAccessControlAllowOrigin
Returns Promise<void>

Interface EndpointManager

Hierarchy

Index

Methods

Methods

getAuthenticatedPath

Deprecated

Parameters

Optional nativeId: string

Returns Promise<string>

getInsecurePublicLocalEndpoint

Deprecated

Parameters

Optional nativeId: string

Returns Promise<string>

getPublicLocalEndpoint

Deprecated

Parameters

Optional nativeId: string

Returns Promise<string>

getPublicPushEndpoint

Deprecated

Parameters

Optional nativeId: string

Returns Promise<string>

getPublicCloudEndpoint

Deprecated

Parameters

Optional nativeId: string

Returns Promise<string>

getPath

Parameters

Optional nativeId: string

Optional options: { public?: boolean; }

Optional public?: boolean

Returns Promise<string>

getLocalEndpoint

Parameters

Optional nativeId: string

Optional options: { public?: boolean; insecure?: boolean; }

Optional public?: boolean

Optional insecure?: boolean

Returns Promise<string>

getCloudEndpoint

Deprecated

Parameters

Optional nativeId: string

Optional options: { public?: boolean; }

Optional public?: boolean

Returns Promise<string>

getCloudPushEndpoint

Parameters

Optional nativeId: string

Returns Promise<string>

setLocalAddresses

Parameters

addresses: string[]

Returns Promise<void>

getLocalAddresses

Returns Promise<string[]>

setAccessControlAllowOrigin

Parameters

options: EndpointAccessControlAllowOrigin

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` nativeId: string

`Optional` nativeId: string

`Optional` nativeId: string

`Optional` nativeId: string

`Optional` nativeId: string

`Optional` nativeId: string

`Optional` options: {
public?: boolean;
}

`Optional` public?: boolean

`Optional` nativeId: string

`Optional` options: {
public?: boolean;
insecure?: boolean;
}

`Optional` public?: boolean

`Optional` insecure?: boolean

`Optional` nativeId: string

`Optional` options: {
public?: boolean;
}

`Optional` public?: boolean

`Optional` nativeId: string