overwolf.social.twitter API
Provides access to the Twitter social provider.
tip
You can use overwolf.social.getDisabledServices() method to check if the service is available.
Methods Reference
- overwolf.social.twitter.performUserLogin()
- overwolf.social.twitter.performLogout()
- overwolf.social.twitter.getUserInfo()
- overwolf.social.twitter.share()
- overwolf.social.twitter.shareEx()
- overwolf.social.twitter.cancelShare()
Events Reference
Types Reference
- overwolf.social.twitter.TwitterShareParameters Object
- overwolf.social.twitter.SocialShareResult Object
- overwolf.social.twitter.SocialShareProgress Object
- overwolf.social.twitter.enums.ShareState Enum
performUserLogin()
Version added: 0.128
Opens the login dialog.
There is no callback for this method and the only way to know if the user signed in is via onLoginStateChanged event.
performLogout(callback)
Version added: 0.125
Performs a "strong" sign out of Twitter, so that even if the user performs a login via the Overwolf Settings / Accounts page, he will be considered signed out.
| Parameter | Type | Description |
|---|---|---|
| callback | (Result) => void | A callback function which will be called with the status of the request |
getUserInfo(callback)
Version added: 0.125
If the user is currently logged into Twitter, this will return user information, Otherwise, an error is returned.
| Parameter | Type | Description |
|---|---|---|
| callback | (Result: GetUserInfoResult) => void | A callback function which will be called with the status of the request |
share(TwitterShareParameters, callback)
Version added: 0.125
If the user is currently logged into YouTube, this will perform the video share.
| Parameter | Type | Description |
|---|---|---|
| twitterShareParams | TwitterShareParameters Object | The share parameters |
| callback | (Result) => void | A callback function which will be called with the status of the request |
Types of errors that can occur:
- Disconnected (user isn't signed in)
- MissingFile (trying to share a missing file)
- UnsupportedFile (trying to share an unsupported format)
shareEx(TwitterShareParameters, callback, callback)
Version added: 0.198
If the user is currently logged into Twitter, this will perform the video share.
| Parameter | Type | Description |
|---|---|---|
| twitterShareParams | TwitterShareParameters Object | The share parameters |
| resultCallback | (SocialShareResult) => void | A callback function which will be called with the resulting status of the request |
| progressCallback | (socialShareProgress) => void | A callback function which will be called whenever share progress is made |
Types of errors that can occur:
- Disconnected (user isn't signed in)
- MissingFile (trying to share a missing file)
- UnsupportedFile (trying to share an unsupported format)
cancelShare(string, callback)
Version added: 0.198
cancels an ongoing share request with the given id, if valid. Callback will be invoked with success if such a request was found and a cancellation order was executed (may take a while)
| Parameter | Type | Description |
|---|---|---|
| id | string | The request ID |
| callback | (Result) => void | Called with the result of the cancellation |
overwolf.social.twitter.cancelShare("2", console.log)
onLoginStateChanged
Version added: 0.125
Fired when the user’s login state changes, with the following structure: LoginStateChangedEvent Object.
TwitterShareParameters Object
Version added: 0.125
This object defines all parameters that can/should be passed to the Twitter
Share()andshareEx()methods.
| Parameter | Type | Description |
|---|---|---|
| file | string | The file to share |
| id (Optional) | string | The ID for the current share request. See note |
| useOverwolfNotifications | boolean | Whether or not overwolf notifications should be used. See note |
| message | string | The message to include with the shared file |
| trimming (Optional) | VideoCompositionSegment | An object containing start time and end time for the desired VideoCompositionSegment |
| tags (Optional) | string | An array of chronological events that occurred during the capture |
| gameClassId (Optional) | int | The associated game's class ID |
| gameTitle (Optional) | string | The associated game's title |
| metadata (Optional) | Object | Extra information about the game session |
id note
When calling overwolf.social.twitter.shareEx(), it is required to supply it with a request ID. This ID will also be used in case you wish to cancel this share using overwolf.social.twitter.cancelShare().
useOverwolfNotifications note
When calling overwolf.social.twitter.share(), this will default to true.
When calling overwolf.social.twitter.shareEx(), this will default to false.
SocialShareResult Object
Version added: 0.198
Container for the url shared in a successful share.
| Parameter | Type | Description |
|---|---|---|
| url | string | The url of the generated result |
SocialShareProgress Object
Version added: 0.198
The current progress of the share request
| Parameter | Type | Description |
|---|---|---|
| progress | int | The current precentage of upload progress |
| id | string | The id of the share request |
| state | ShareState | The current state of the share request |
Example data
{
"progress": 78,
"id": "3",
"state": "Uploading"
}
ShareState Enum
Version added: 0.198
The current state of the
overwolf.social.twitter.shareEx()operation.
| Options | Description |
|---|---|
| Started | The upload has started |
| Uploading | The upload is in progress |
| Finished | The upload has finished |