diff --git a/TwitchWebhook.html b/TwitchWebhook.html index 084bee7..d6e4ac5 100644 --- a/TwitchWebhook.html +++ b/TwitchWebhook.html @@ -19,7 +19,7 @@

Class: TwitchWebhook

- + @@ -27,28 +27,28 @@

Class: TwitchWebhook

- +

TwitchWebhook(options)

- +
Twitch Webhook API
- - + +
- - - + + +

Constructor

- - + +

new TwitchWebhook(options)

- - + + @@ -65,500 +65,509 @@

new Twit

Parameters:
- + - + - + - - + + - + - + - + - - + + - +
NameTypeDescription
options - - + + Object - + Options
Properties
- + - + - + - + - - + + - + - + - + - + - + - - + + - + - + - + - + - + - - + + - + + + + + + + + + - - + - + - + - - + + - + - + - + - + - + - - + + - + - + - + - + - + - - + + - + - + - + - + - + - - + + - + - + - + - + - + - - + + - + - +
NameTypeAttributesDefaultDescription
client_id - - + + string - + - - - + + + - + Client ID required for Twitch API calls
callback - - + + string - + - - - + + + - + URL where notifications will be delivered.
access_token + string + <optional>ignoredAccess token used to increase rate limits
secret - - + + string - + - + <optional>
- - - + + +
- + false - + Secret used to sign notification payloads.
lease_seconds - - + + number - + - + <optional>
- - - + + +
- + 864000 - + Number of seconds until the subscription expires.
listen - - + + boolean | Object - + - + <optional>
- - - + + +
- + Listen options
Properties
- + - + - + - + - - + + - + - + - + - + - + - - + + - + - + - + - + - + - - + + - + - + - + - + - + - - + + - + - +
NameTypeAttributesDefaultDescription
autoStart - - + + string - + - + <optional>
- - - + + +
- + true - + Should automaticaly starts listening
host - - + + string - + - + <optional>
- - - + + +
- + "0.0.0.0" - + Host to bind to
port - - + + number - + - + <optional>
- - - + + +
- + 8443 - + Port to bind to
https - - + + boolean | Object - + - + <optional>
- - - + + +
- + false - + Should use https connection. If yes, these options to be passed to `https.createServer()`.
baseApiUrl - - + + string - + - + <optional>
- - - + + +
- + "https://api.twitch.tv/helix/" - + Base Twitch API URL. Needed proxying and testing
@@ -569,42 +578,42 @@
Properties
- - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + +
@@ -624,26 +633,26 @@
Properties
- +
- - - - - - - + + + + + + +

Members

- - + +

errors

@@ -661,42 +670,42 @@

errors - - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + + @@ -704,22 +713,22 @@

errorsMethods

- - - - + + + +

close() → {Promise}

- - + + @@ -741,42 +750,42 @@

close - - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + + @@ -793,7 +802,7 @@

closeReturns:

- +
@@ -801,29 +810,29 @@
Returns:
Type
- + Promise
- - - - - + + + + +

isListening() → {boolean}

- - + + @@ -845,42 +854,42 @@

isListenin
- - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + +
@@ -897,7 +906,7 @@

isListenin

Returns:
- +
@@ -905,29 +914,29 @@
Returns:
Type
- + boolean
- - - - - + + + + +

listen(…argsopt) → {Promise}

- - + + @@ -944,64 +953,64 @@

listenParameters:

- + - + - + - + - - + + - + - + - + - + - - + + - +
NameTypeAttributesDescription
args - - + + any - + - + <optional>
- - - + + + <repeatable>
- +
Arguments
@@ -1012,42 +1021,42 @@
Parameters:
- - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + +
@@ -1062,7 +1071,7 @@
Parameters:
Throws:
- +
@@ -1077,7 +1086,7 @@
Throws:
Type
- + Promise.<FatalError> @@ -1088,12 +1097,12 @@
Throws:
- +
Returns:
- +
@@ -1101,29 +1110,29 @@
Returns:
Type
- + Promise
- - - - - + + + + +

subscribe(topic, options) → {Promise}

- - + + @@ -1140,73 +1149,73 @@

subscribeParameters:

- + - + - + - - + + - + - + - + - - + + - + - + - + - - + + - +
NameTypeDescription
topic - - + + string - + Topic name
options - - + + Object - + Topic options
@@ -1217,42 +1226,42 @@
Parameters:
- - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + +
@@ -1267,7 +1276,7 @@
Parameters:
Throws:
- +
@@ -1282,7 +1291,7 @@
Throws:
Type
- + RequestDenied @@ -1293,12 +1302,12 @@
Throws:
- +
Returns:
- +
@@ -1306,29 +1315,29 @@
Returns:
Type
- + Promise
- - - - - + + + + +

unsubscribe(topic) → {Promise}

- - + + @@ -1346,50 +1355,50 @@

unsubscrib

Parameters:
- + - + - + - - + + - + - + - + - - + + - +
NameTypeDescription
topic - - + + string - + Topic name
@@ -1400,42 +1409,42 @@
Parameters:
- - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + +
@@ -1450,7 +1459,7 @@
Parameters:
Throws:
- +
@@ -1465,7 +1474,7 @@
Throws:
Type
- + RequestDenied @@ -1476,12 +1485,12 @@
Throws:
- +
Returns:
- +
@@ -1489,25 +1498,25 @@
Returns:
Type
- + Promise
- - - - - + + + + +

@@ -1530,4 +1539,4 @@

Home

Classes