Table of contents
Description
This method "checks-in" the user to a specified place, on multiple social networks that support this feature.
Note: In Facebook and Twitter, checking in is done via status update location parameters.
Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to REST API > socialize.checkin.
Supporting Providers
This operation is currently supported by the following providers: FourSquare, Facebook, Twitter.
Notes:
1. Before your application can check-in in Facebook, the user must grant your application an extended permission. Please make sure you have checked the "Enable checkin" check box in the Site Setup > Permissions page on Gigya's website. During the Social Login process, the user will be presented with a Facebook UI in which she can authorize your application to perform checkins on her behalf.
Please, read more in the Facebook Setting - Permissions guide.
2. In Twitter, the check-in operation is supported for users only if they choose so in their account settings. The user should check the "Add a location to your tweets" check-box in his Twitter account settings.
Syntax
gigya.socialize.checkin(params)
Method Parameters
The following table lists the params object members:
| Required | Name | Type | Description |
| Required | placeID | string | A unique identifier of the place to which to check-in. Note: you may receive a list of place identifiers using the socialize.getPlaces method. |
| comment | string | A user comment associated with the check-in action. | |
| Required* | latitude | float | The decimal latitude of the user. * The parameter is required by Facebook only. |
| longitude | float | The decimal longitude of the user. * The parameter is required by Facebook only. | |
| Optional | callback | function | A reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes. The callback function should be defined with the following signature: functionName(response). The "Response object Data Members" table below provides specification of the data that is passed to the callback function. |
| enabledProviders | string | A comma-delimited list of provider names to include in the method execution. This parameter gives the possibility to apply this method only to a subset of providers of your choice. If you do not set this parameter, by default all the providers are enabled (i.e. the method applies to all connected providers). For example, if you would like the method to apply only to Facebook and Twitter, define: enabledProviders="facebook,twitter". Valid provider names include: 'facebook', 'twitter', 'foursquare'. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| disabledProviders | string | A comma-delimited list of provider names to exclude in the method execution. This parameter gives the possibility to specify providers to which that you don't want this method to apply. If you do not set this parameter, by default no provider is disabled (i.e. the method applies to all connected providers). For example, if you would like the method to apply to all providers except Google and Twitter, define: disabledProviders="google,twitter". Valid provider names include: 'facebook', 'twitter', 'foursquare'. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| cid | string | A string of maximum 100 characters length. This string is associated with each transaction and will later appear on reports generated by Gigya in the "Context ID" combo box. The cid allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. The "Context ID" combo box lets you filter the report data by site/application context. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| context | object | A developer-created object that is passed back unchanged to the application as one of the fields in the response object. | |
| actionAttributes | JSON object | In Gamification your users receive points for actions they perform on your site, in this case checking in grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the web site that generated the action. If you set here the actionAttributes, each time a user checks in, the action also receives an attribute, for example "tv-show":"glee", which can mean that the action was performed on the "Glee" page of the site. These action attributes are later used to display the GM Plugins filtered according to a certain attribute. For example, you can show the Leaderboard plugin only for top users on the "Glee" page. This parameter receives a JSON object, comprised of a set or sets of a key (category) and a value or values, i.e.: "tv-show": ["glee", "30rock"], |
Response Object Data Members
| Field | Type | Description |
| errorCode | integer | The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table. |
| errorMessage | string | A short textual description of an error associated with the errorCode for logging purposes. |
| operation | string | The name of the API method that generated this response. |
| context | object | The context object passed by the application as parameter to the API method, or null if no context object has been passed. |
| providerCheckinIDs | JSON Object | A JSON object containing a list of providers, each with its unique identifier of the checked-in place. The object looks something like: providerCheckinIDs : {
facebook: "123njhnj",
foursquare: "kjf89yu8",
twitter: "njbkjkl"
} |
Code Sample
var params= {
placeID: "voaewU4S",
comment: "This is a great place!",
latitude: 23.2323,
longitude: 43.234
};
gigya.socialize.checkin(params); - This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
- To run the code on your own domain, add your Gigya API key to the socialize.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
- In some cases it is necessary to connect/login the user to a provider? prior to calling the API method. You can learn more in the Social Login guide.
Comments