ProtoFlux:Request Host Access

From Resonite Wiki
Revision as of 23:47, 19 May 2024 by AmasterAmaster (talk | contribs) (Added some notes on the scope overriding the url protocol.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Request Host Access
*
OnGranted
Host
OnDenied
Port
OnIgnored
Scope
Reason
Network

The Request Host Access node takes in a Host IP address, an accessible port of that address, the scope of what type of connection this is, and the reason why this user should connect to this service. When everything is accurate, this node will fire an event depending if this local user has successfully connected to the host service. This relates to the settings in the Dash that a user can look through to see what services they have access to.

This node is useful for allowing you to interchange the host and port separately, but if you want to just have the Uri version for convenience, use Request Host Access Url instead.

If you provide a scheme (also called a protocol) inside the host string, it will be overridden by the scope every time, as the scope takes priority to determine the type of the network connection. A scheme looks like https:// or ws://.

Inputs

* (Async Call)

Calls an impulse to request the host's access to a service.

Host (string)

The IP address to connect to.

Port (int)

The Port Number used to access this IP address.

Scope (HostAccessScope)

The access type used for this network connection.

Reason (string)

The reason to why this user should allow access to the host's service.

Outputs

OnGranted (Continuation)

Fires when the local user has accepted the host access to the service. This adds to thier list of host accesses in the settings in the Dash.

OnDenied (Continuation)

Fires when the local user has declined the host access to the service.

OnIgnored (Continuation)

Fires when the local user has clicked the close button on the pop-up dialoge that asks for the host access, or somehow avoided the notification through other means.