Opensocial.Organization (v0.9)
- Mark Halvorson (Deactivated)
NeedsExamples
opensocial.Organization
Base interface for all organization objects.
Methods
opensocial.Organization.getField
;String getField(key, opt_params)
Parameters
NameTypeDescription |
key |
String |
The key to get data for; keys are defined in Organization.Field |
|
opt_params |
Map.<opensocial.DataRequest.DataRequestFields |
Object> |
Additional params to pass to the request |
Returns
TypeDescription |
String |
The data |
Description
Gets data for this body type that is associated with the specified key.
opensocial.Organization.Field
All of the fields that a organization has. These are the supported keys for the Organization.getField() method.
opensocial.Organization.Field.ADDRESS
The address of the organization, specified as an opensocial.Address. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'address'.
opensocial.Organization.Field.DESCRIPTION
<static> Member of: opensocial.Organization.Field.DESCRIPTION A description or notes about the person's work in the organization, specified as a string. This could be the courses taken by a student, or a more detailed description about a Organization role. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'description'.
opensocial.Organization.Field.END_DATE
The date the person stopped at the organization, specified as a Date. A null date indicates that the person is still involved with the organization. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'endDate'.
opensocial.Organization.Field.FIELD
The field the organization is in, specified as a string. This could be the degree pursued if the organization is a school. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'field'.
opensocial.Organization.Field.NAME
The name of the organization, specified as a string. For example, could be a school name or a job company. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'name'.
opensocial.Organization.Field.SALARY
The salary the person receieves from the organization, specified as a string. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'salary'.
opensocial.Organization.Field.START_DATE
<static> Member of: opensocial.Organization.Field.START_DATE The date the person started at the organization, specified as a Date. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'startDate'.
opensocial.Organization.Field.SUB_FIELD
The subfield the Organization is in, specified as a string. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'subField'.
opensocial.Organization.Field.TITLE
The title or role the person has in the organization, specified as a string. This could be graduate student, or software engineer. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'title'.
opensocial.Organization.Field.WEBPAGE
A webpage related to the organization, specified as a string. Container support for this field is OPTIONAL. This field may be used interchangeably with the string 'webpage'.
{{ JsApiAlphaList_(v0.9) }}