ProtoFlux:Request Host Access Url: Difference between revisions

From Resonite Wiki
Created the page for the Request Host Access Url node.
 
Added some notes on the scope overriding the url protocol.
 
Line 20: Line 20:


{{Note|This node is useful for convenience of having the host and port combined, but if you want to just have the Host IP Address and Port Number separate, use [[ProtoFlux:Request Host Access|Request Host Access]] instead.|suggestion}}
{{Note|This node is useful for convenience of having the host and port combined, but if you want to just have the Host IP Address and Port Number separate, use [[ProtoFlux:Request Host Access|Request Host Access]] instead.|suggestion}}
If you provide a scheme (also called a protocol) inside the Url, 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 <code>https://</code> or <code>ws://</code>.


== Inputs ==
== Inputs ==

Latest revision as of 23:43, 19 May 2024

Request Host Access
*
OnGranted
Host
OnDenied
Reason
OnIgnored
Scope
Network

The Request Host Access Url node takes in a Host IP address (and optionally accessible port of that address if provided), 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 convenience of having the host and port combined, but if you want to just have the Host IP Address and Port Number separate, use Request Host Access instead.

If you provide a scheme (also called a protocol) inside the Url, 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 (Uri)

The IP address and Port Number to connect to.

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 their 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 dialogue that asks for the host access, or somehow avoided the notification through other means.