Class opensocial.NavigationParameters
Parameters used by RequestShareApp to instruct the container on where to go
after the request is made.
It could be used, for example, to specify where viewers get routed
in one of two cases:
1) After a user gets a shareApp invitation or receives a message a gadget
developer should be able to send that user to a context sensitive place.
2) After a viewer actually shares an app with someone else the gadget
developer should be able to redirect the viewer to a context sensitive
place.
Defined in: opensocial.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
|
getField(key, opt_params)
Gets the NavigationParameters' data that's associated with the specified key.
|
|
|
setField(key, data)
Sets data for this NavigationParameters associated with the given key.
|
Method Detail
{String}
getField(key, opt_params)
Gets the NavigationParameters' data that's associated with the specified key.
- Parameters:
- {String} key
- The key to get data for; see the Field class for possible values
- {Map.<opensocial.DataRequest.DataRequestFields|Object>} opt_params
- Additional params to pass to the request.
- Returns:
- {String} The data
setField(key, data)
Sets data for this NavigationParameters associated with the given key.
- Parameters:
- {String} key
- The key to set data for
- {Object} data
- The data to set