Skip to main content

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

Events Reference

Types Reference

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.

ParameterTypeDescription
callback(Result) => voidA 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.

ParameterTypeDescription
callback(Result: GetUserInfoResult) => voidA 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.

ParameterTypeDescription
twitterShareParamsTwitterShareParameters ObjectThe share parameters
callback(Result) => voidA 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.

ParameterTypeDescription
twitterShareParamsTwitterShareParameters ObjectThe share parameters
resultCallback(SocialShareResult) => voidA callback function which will be called with the resulting status of the request
progressCallback(socialShareProgress) => voidA 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)

ParameterTypeDescription
idstringThe request ID
callback(Result) => voidCalled 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() and shareEx() methods.

ParameterTypeDescription
filestringThe file to share
id (Optional)stringThe ID for the current share request. See note
useOverwolfNotificationsbooleanWhether or not overwolf notifications should be used. See note
messagestringThe message to include with the shared file
trimming (Optional)VideoCompositionSegmentAn object containing start time and end time for the desired VideoCompositionSegment
tags (Optional)stringAn array of chronological events that occurred during the capture
gameClassId (Optional)intThe associated game's class ID
gameTitle (Optional)stringThe associated game's title
metadata (Optional)ObjectExtra 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.

ParameterTypeDescription
urlstringThe url of the generated result

SocialShareProgress Object

Version added: 0.198

The current progress of the share request

ParameterTypeDescription
progressintThe current precentage of upload progress
idstringThe id of the share request
stateShareStateThe 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.

OptionsDescription
StartedThe upload has started
UploadingThe upload is in progress
FinishedThe upload has finished