Difference between revisions of "Opensocial.Phone (v0.9)"
From VZ Developer Wiki
(Created page with '{{NeedsExamples}} <div style="float:right; margin: 0 0 10px 10px;">__TOC__</div> <span style="font-size:150%"><strong>opensocial.Phone</strong></span> Base interface for all ph…') |
(→opensocial.Phone.Field) |
||
Line 22: | Line 22: | ||
All of the fields that a phone has. These are the supported keys for the [[opensocial.Phone.getField (v0.9) | Phone.getField()]] method. | All of the fields that a phone has. These are the supported keys for the [[opensocial.Phone.getField (v0.9) | Phone.getField()]] method. | ||
− | === | + | === value === |
− | :The phone number, specified as a string | + | :The phone number, specified as a string. |
=== opensocial.Phone.Field.TYPE === | === opensocial.Phone.Field.TYPE === | ||
:The phone number type or label, specified as a string. Examples: work, my favorite store, my house, etc. This field may be used interchangeably with the string 'type'. | :The phone number type or label, specified as a string. Examples: work, my favorite store, my house, etc. This field may be used interchangeably with the string 'type'. |
Latest revision as of 07:15, 27 April 2011
This documentation is not completed yet and will be extended by more examples in future.
opensocial.Phone
Base interface for all phone objects.
Methods
opensocial.Phone.getField
String getField(key, opt_params)
- Parameters
Name Type Description key String The key to get data for; keys are defined in Phone.Field opt_params Map.<opensocial.DataRequest.DataRequestFields|Object> Additional params to pass to the request.
- Returns
Type Description String The data
- Description
Gets data for this phone that is associated with the specified key.
opensocial.Phone.Field
All of the fields that a phone has. These are the supported keys for the Phone.getField() method.
value
- The phone number, specified as a string.
opensocial.Phone.Field.TYPE
- The phone number type or label, specified as a string. Examples: work, my favorite store, my house, etc. This field may be used interchangeably with the string 'type'.
OpenSocial (v0.9) | |||
opensocial.Phone |