overwolf.logitech.arx

Provides API for Logitech Arx Control.

Methods

init(identifier, friendlyName, callback)

Version added: 0.93.1

Initializes the Arx API.

  • Parameter: identifier <string>

    An id for the app that will be discovered by LGS.
  • Parameter: friendlyName <string>

    A friendly display name.
  • Parameter: callback <function>

    A callback with the result of the request.

publishApp(indexFilename, callback)

Version added: 0.93.1

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

  • Parameter: indexFilename <string>

    An optional file to use as index index.
  • Parameter: callback <function>

    A callback with the result of the request.

addFileAs(fileUrl, fileName, mimeType, callback)

Version added: 0.93.1

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

  • Parameter: fileUrl <string>

    The Overwolf url to add.
  • Parameter: fileName <string>

    The file name to add as.
  • Parameter: mimeType <string>

    An optional mime type.
  • Parameter: callback <function>

    A callback with the result of the request.

addContentAs(base64Content, fileName, callback)

Version added: 0.93.1

Adds content from a base64 string.

  • Parameter: base64Content

    The base64 string.
  • Parameter: fileName <string>

    The file name to add as.
  • Parameter: callback <function>

    A callback with the result of the request.

addContentAs(content, fileName, mimeType, callback)

Version added: 0.93.1

Adds content from a byte array.

  • Parameter: content <Byte[]>

    The byte array.
  • Parameter: fileName <string>

    The file name to add as.
  • Parameter: mimeType <string>

    An optional mime type.
  • Parameter: callback <function>

    A callback with the result of the request.

addUtf8StringAs(stringContent, fileName, mimeType, callback)

Version added: 0.93.1

Adds content from a UTF8 string.

  • Parameter: stringContent <string>

    The UTF8 string.
  • Parameter: fileName <string>

    The file name to add as.
  • Parameter: mimeType <string>

    An optional mime type.
  • Parameter: callback <function>

    A callback with the result of the request.

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

Version added: 0.93.1

Add an image from a bitmap.

  • Parameter: bitmap <Byte[]>

    A byte array representing a bitmap.
  • Parameter: width <int>

    The width of the bitmap.
  • Parameter: height <int>

    The height of the bitmap.
  • Parameter: fileName <string>

    The file name to add as.
  • Parameter: callback <function>

    A callback with the result of the request.

setIndex(fileName, callback)

Version added: 0.93.1

Sets the index file of the website.

  • Parameter: fileName <string>

    The file to use as index.
  • Parameter: callback <function>

    A callback with the result of the request.

setTagPropertyById(tagId, prop, newValue, callback)

Version added: 0.93.1

Sets a property of a tag by ID.

  • Parameter: tagId <string>

    The ID of the tag to set the property to.
  • Parameter: prop <string>

    The name of the property to change.
  • Parameter: newValue <string>

    The new value.
  • Parameter: callback <function>

    A callback with the result of the request.

setTagsPropertyByClass(tagsClass, prop, newValue, callback)

Version added: 0.93.1

Sets a property of a tag(s) by class.

  • Parameter: tagsClass <string>

    The class of the tag(s) to set the property to.
  • Parameter: prop <string>

    The name of the property to change.
  • Parameter: newValue <string>

    The new value.
  • Parameter: callback <function>

    A callback with the result of the request.

setTagContentById(tagId, newContent, callback)

Version added: 0.93.1

Sets the content of a tag by ID.

  • Parameter: tagId <string>

    The ID of the tag to set the content to.
  • Parameter: newContent <string>

    The new content.
  • Parameter: callback <function>

    A callback with the result of the request.

setTagsContentByClass(tagsClass, newContent, callback)

Version added: 0.93.1

Sets the content of a tag(s) by class.

  • Parameter: tagsClass <string>

    The class of the tag(s) to set the content to.
  • Parameter: newContent <string>

    The new content.
  • Parameter: callback <function>

    A callback with the result of the request.

shutdown()

Version added: 0.93.1

Shuts down the API.

Events How to use events

onEvent

Version added: 0.93.1

An Arx event send with a Logitech Arx Event Data object.

onError

Version added: 0.93.1

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

Types

Logitech.Arx.Event.Data

Describes an Arx event.

Properties

eventType

Version added: 0.93.1

The type code of the event.

Type: int

eventTypeString

Version added: 0.93.1

The type name of the event.

Type: string

eventValue

Version added: 0.93.1

The value code of the event.

Type: int

eventValueString

Version added: 0.93.1

The value string on the event.

Type: string

eventArg

Version added: 0.93.1

The argument of the event.

Type: string

context

Version added: 0.93.1

The context of the event.

Type: IntPtr