Component:HostAccessSettings: Difference between revisions

Latest revision as of 22:13, 7 April 2025

Component image

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`Entries`	direct SyncDictionary`2<String, HostAccessSettings.Entry>	A list of allowed and denied IP address locations.

Fields
Name	Type	Description
`AllowHTTP_Requests`	Bool	This indicayes of HTTP(S) requests are allowed for this host. These are typically REST API requests to communicate with third party services.
`AllowWebsockets`	Bool	This indicates if realtime Websocket connections are allowed for this host. These are often used for more realtime bi-directional communications and data streams.
`AllowOSC_Receiving`	Bool	This indicates if Resonite can receive and process OSC data
`AllowOSC_Sending`	Bool	This controls if Resonite is allowed to send data via OSC protocol to given host
`HTTP_RequestsSet`	Bool	Whether `AllowHTTP_Requests` should be toggled soon.
`WebsocketsSet`	Bool	Whether `AllowWebsockets` should be toggled soon.
`OSC_SenderSet`	Bool	Whether `AllowOSC_Receiving` should be toggled soon.
`OSC_ReceiverSet`	Bool	Whether `AllowOSC_Sending` should be toggled soon.
`LastHyperlinkRequestReason`	String	The last reason given for accessing a website.
`LastWebsocketRequestReason`	String	The last reason given for accessing a web socket.
`LastOSC_SenderRequestReason`	String	The last reason given for sending OSC data.
`LastOSC_ReceiverRequestReason`	String	The last reason given for receiving OSC data.
`AllowedPorts`	direct SyncFieldList`1<Int>	The number ports allowed from this entry address.
`BlockedPorts`	direct SyncFieldList`1<Int>	The number ports blocked from this entry address.

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`GetEntry:SubsettingGetter`	SubsettingGetter	X	Gets an entry of type HostAccessSettings.Entry from the list of `Entries`.

@@ Line 7: / Line 7: @@
 == Fields ==
 {{Table ComponentFields
-|Entries|{{RootFieldType|SyncDictionary`2|[[Type:String|String]], [[#Entry|Entry]]}}|TypeAdv0=true| A list of allowed and denied IP address locations.
+|Entries|{{RootFieldType|SyncDictionary`2|[[Type:String|String]], [[#Entry|HostAccessSettings.Entry]]}}|TypeAdv0=true| A list of allowed and denied IP address locations.
 }}
@@ Line 30: / Line 30: @@
 == Sync Delegates ==
 {{Table ComponentTriggers
-|GetEntry()|[[Type:SubsettingGetter|SubsettingGetter]]&lt;[[Type:String|String]]: key&gt;| Get an entry under this component using a key.
+|GetEntry:[[Type:SubsettingGetter|SubsettingGetter]]|[[Type:SubsettingGetter|SubsettingGetter]]|false| Gets an entry of type [[#Entry|HostAccessSettings.Entry]] from the list of <code>Entries</code>.
 }}