Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›overwolf.social

API Reference

  • Changelog
  • Overview

App Manifest

  • manifest.json
  • Validate your manifest

Available Game Events

  • Games IDs
  • Apex Legends
  • Call of Duty: Warzone
  • CS:GO
  • Dota 2
  • Final Fantasy XIV
  • Dota Underlords
  • Escape From Tarkov
  • Fortnite
  • Hearthstone
  • Heroes of the Storm
  • Legends of Runeterra
  • League of Legends
  • Minecraft
  • MTG Arena
  • Overwatch
  • Path of Exile
  • PUBG
  • PUBG Lite
  • Rainbow Six Siege
  • Rocket League
  • StarCraft II
  • Teamfight Tactics
  • Valorant
  • World of Tanks
  • World of Warcraft
  • World of Warships
  • Warframe
  • Various External APIs

Game Launchers Events

  • Launchers IDs
  • LOL Launcher

overwolf.benchmarking

  • overwolf.benchmarking

overwolf.campaigns

  • overwolf.campaigns.crossapp

overwolf.cryptography

  • overwolf.cryptography

overwolf.extensions

  • overwolf.extensions
  • overwolf.extensions.current
  • overwolf.extensions.sharedData
  • overwolf.extensions.io

overwolf.games

  • overwolf.games
  • overwolf.games.events
  • overwolf.games.inputTracking
  • overwolf.games.launchers
  • overwolf.games.launchers.events

overwolf.io

  • overwolf.io
  • overwolf.io.paths

overwolf.logitech

  • overwolf.logitech
  • overwolf.logitech.arx
  • overwolf.logitech.led

overwolf.media

  • overwolf.media
  • overwolf.media.audio
  • overwolf.media.replays
  • overwolf.media.videos
  • Highlights supported games

overwolf.os

  • overwolf.os
  • overwolf.os.tray

overwolf.profile

  • overwolf.profile
  • overwolf.profile.subscriptions

overwolf.settings

  • overwolf.settings
  • overwolf.settings.hotkeys
  • overwolf.settings.language
  • overwolf.settings.games

overwolf.social

  • overwolf.social
  • overwolf.social.reddit
  • overwolf.social.youtube
  • overwolf.social.discord
  • overwolf.social.gfycat
  • overwolf.social.twitter

overwolf.streaming

  • overwolf.streaming

overwolf.tobii

  • overwolf.tobii

overwolf.utils

  • overwolf.utils

overwolf.web

  • overwolf.web
  • overwolf.web.webserver
  • overwolf.web.websocket

overwolf.windows

  • overwolf.windows
Edit

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()

Events Reference

  • ooverwolf.social.twitter.onLoginStateChanged

Types Reference

  • overwolf.social.twitter.TwitterShareParameters Object

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(twitterShareParams , callback)

Version added: 0.125

If the user is currently logged into YouTube, this will perform the video share.

|twitterShareParams| is of type errors that can occur:- Disconnected (user isn’t signed in)- MissingFile (trying to share a missing file)- UnsupportedFile (trying to share an unsupported format)

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)

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 Twitter |share| function.

ParameterTypeDescription
filestringThe file to share
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
Last updated on 2020-12-13 by eransharv
← overwolf.social.gfycatoverwolf.streaming →
  • Methods Reference
  • Events Reference
  • Types Reference
  • performUserLogin()
  • performLogout(callback)
  • getUserInfo(callback)
  • share(twitterShareParams , callback)
  • onLoginStateChanged
  • TwitterShareParameters Object
  • Legal
  • Terms overview
  • Developer's terms
  • App terms
  • Overwolf terms
  • Overwolf Privacy policy
  • Support
  • Questions and Answers
  • Discord
  • Slack
  • Facebook
  • Twitter
  • Documentation
  • Changelog
  • API
  • App Creation Process
  • Best Practices
  • Game Events status
  • Information
  • Careers
  • Fund
  • Developers Blog
  • Overwolf Appstore
  • Advertise on Overwolf