overwolf.social.gfycat API
Provides access to the Gfycat social provider.
You can use overwolf.social.getDisabledServices()
method to check if the service is available.
Methods Reference
- overwolf.social.gfycat.performUserLogin()
- overwolf.social.gfycat.performLogout()
- overwolf.social.gfycat.getUserInfo()
- overwolf.social.gfycat.share()
- overwolf.social.gfycat.shareEx()
- overwolf.social.gfycat.cancelShare()
Events Reference
Types Reference
- overwolf.social.gfycat.gfycatShareParameters Object
- overwolf.social.gfycat.SocialShareResult Object
- overwolf.social.gfycat.SocialShareProgress Object
- overwolf.social.gfycat.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 Gfycat, 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 Gfycat, 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(GfycatShareParameters, callback)
Version added: 0.125
If the user is currently logged into YouTube, this will perform the video share.
Parameter | Type | Description |
---|---|---|
gfycatShareParams | GfycatShareParameters 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)
- ExceedsMaxSize (the file is too large: > 8 MB for images, > 100 MBfor videos)
shareEx(GfycatShareParameters, callback, callback)
Version added: 0.198
If the user is currently logged into Gfycat, this will perform the video share.
Parameter | Type | Description |
---|---|---|
gfycatShareParams | GfycatShareParameters 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. See note |
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)
- ExceedsMaxSize (the file is too large: > 8 MB for images, > 100 MBfor videos)
Progress Note
This callback will only be called when uploading a video.
Videos will be uploaded in uniforamlly sized chunks (except for the last chunk). The callback will be called every time another chunk was successfully uploaded.
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.gfycat.cancelShare("2", console.log)
onLoginStateChanged
Version added: 0.125
Fired when the user’s login state changes, with the following structure: LoginStateChangedEvent Object.
GfycatShareParameters Object
Version added: 0.125
This object defines all parameters that can/should be passed to the Gfycat
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 |
trimming (Optional) | VideoCompositionSegment | An object containing start time and end time for the desired VideoCompositionSegment |
title | string | The message to include with the shared file |
privateMode | bool | Only relevant for when the user is logged in, we then allow him toupload the file to his Gfycat account with private set to true. Default value: false |
tags (Optional) | string | An array of chronological events that occurred during the capture |
gameClassId (Optional) | int | The associated game's class ID |
metadata (Optional) | Object | Extra information about the game session |
id note
When calling overwolf.social.gfycat.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.gfycat.cancelShare()
.
useOverwolfNotifications note
When calling overwolf.social.gfycat.share()
, this will default to true.
When calling overwolf.social.gfycat.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 |
Example data
{
"url": "https://gfycat.com/helpfulignorantfoxterrier"
}
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": 44,
"id": "1",
"state": "Uploading"
}
ShareState Enum
Version added: 0.198
The current state of the
overwolf.social.gfycat.shareEx()
operation.
Options | Description |
---|---|
Started | The upload has started |
Uploading | The upload is in progress |
Finished | The upload has finished |