Edit

overwolf.logitech.arx API

An API for Logitech Arx Control features.

Methods Reference

• overwolf.logitech.arx.init()
• overwolf.logitech.arx.publishApp()
• overwolf.logitech.arx.addFileAs()
• overwolf.logitech.arx.addContentAs()
• overwolf.logitech.arx.addContentAs()
• overwolf.logitech.arx.addUtf8StringAs()
• overwolf.logitech.arx.addImageFromBitmap()
• overwolf.logitech.arx.setIndex()
• overwolf.logitech.arx.setTagPropertyById()
• overwolf.logitech.arx.setTagsPropertyByClass()
• overwolf.logitech.arx.setTagContentById()
• overwolf.logitech.arx.setTagsContentByClass()
• overwolf.logitech.arx.shutdown()

Events Reference

• overwolf.logitech.arx.onEvent
• overwolf.logitech.arx.onError

Types Reference

• Logitech.Arx.Event.Data Object.

init(identifier, friendlyName, callback)

Version added: 0.93

Initializes the Arx API.

Parameter	Type	Description
identifier	string	ID for the app that will be discovered by LGS
friendlyName	string	Friendly display name
callback	function	Callback with the result of the request

publishApp(indexFilename, callback)

Version added: 0.93

Publishes an entire app according to the folder set in the manifest file and/or optional sets in an index file.

Parameter	Type	Description
indexFilename	string	Optional file to use as index
callback	function	Callback with the result of the request

addFileAs(fileUrl, fileName, mimeType, callback)

Version added: 0.93

Adds a file using an overwolf-extension:// or overwolf-media:// url.

Parameter	Type	Description
fileUrl	string	Overwolf url to add
fileName	string	File name to add as
mimeType	string	Optional mime type
callback	function	Callback with the result of the request

addContentAs(base64Content, fileName, callback)

Version added: 0.93

Adds content from a base64 string.

Parameter	Type	Description
base64Content	string	Base64 string
fileName	string	File name to add as
callback	function	Callback with the result of the request

addContentAs(content, fileName, mimeType, callback)

Version added: 0.93

Adds content from a byte array.

Parameter	Type	Description
content	Byte[]	Base64 string
fileName	string	File name to add as
mimeType	string	Optional mime type
callback	function	Callback with the result of the request

addUtf8StringAs(stringContent, fileName, mimeType, callback)

Version added: 0.93

Adds content from a UTF8 string.

Parameter	Type	Description
stringContent	string	UTF8 string
fileName	string	File name to add as
mimeType	string	Optional mime type
callback	function	Callback with the result of the request

addImageFromBitmap(bitmap, width, height, fileName, callback)

Version added: 0.93

Add an image from a bitmap.

Parameter	Type	Description
bitmap	Byte[]	A byte array representing a bitmap
width	int	Width of the bitmap
height	int	Height of the bitmap
fileName	string	File name to add as
callback	function	Callback with the result of the request

setIndex(fileName, callback)

Version added: 0.93

Sets the index file of the website.

Parameter	Type	Description
fileName	string	File to use as index
callback	function	Callback with the result of the request

setTagPropertyById(tagId, prop, newValue, callback)

Version added: 0.93

Sets a property of a tag by ID.

Parameter	Type	Description
tagId	string	ID of the tag to set the property to
prop	string	Name of the property to change
newValue	string	New value
fileName	string	File name to add as
callback	function	Callback with the result of the request

setTagsPropertyByClass(tagsClass, prop, newValue, callback)

Version added: 0.93

Sets a property of a tag by class.

Parameter	Type	Description
tagsClass	string	Class of the tag(s) to set the property to
prop	string	Name of the property to change
newValue	string	New value
callback	function	Callback with the result of the request

setTagContentById(tagId, newContent, callback)

Version added: 0.93

Sets the content of a tag by ID.

Parameter	Type	Description
tagId	string	ID of the tag to set the content to
newContent	string	New content
callback	function	Callback with the result of the request

setTagsContentByClass(tagsClass, newContent, callback)

Version added: 0.93

Sets the content of a tag by ID.

Parameter	Type	Description
tagsClass	string	Class of the tag(s) to set the content to
newContent	string	New content
callback	function	Callback with the result of the request

shutdown()

Version added: 0.93

Shuts down the API.

onEvent

Version added: 0.93

An Arx event sent with a [Logitech.Arx.Event.Data] object.

onError

Version added: 0.93

Triggered when an error occurs, sent with an error code.

Logitech.Arx.Event.Data Object

Version added: 0.93

Describes an Arx event.

Parameter	Type	Description
eventType	int	Type code of the event
eventTypeString	string	Type name of the event
eventValue	int	Value code of the event
eventValueString	string	Value string on the event
eventArg	string	Argument of the event
context	IntPtr	Context of the event