features.opensocial-reference.person.js Maven / Gradle / Ivy
Go to download
Packages all the features that shindig provides into a single jar file to allow
loading from the classpath
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*global opensocial */
/**
* @fileoverview Representation of a person.
*/
/**
* @class
* Base interface for all person objects.
*
* @name opensocial.Person
*/
/**
* Base interface for all person objects.
*
* @private
* @constructor
* @deprecated since 1.0 see http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Gadget.xml#rfc.section.A.45.
*/
opensocial.Person = function(opt_params, opt_isOwner, opt_isViewer) {
this.fields_ = opt_params || {};
this.isOwner_ = opt_isOwner;
this.isViewer_ = opt_isViewer;
};
/**
* @static
* @class
* All of the fields that a person has. These are the supported keys for the
* Person.getField() method.
*
* @name opensocial.Person.Field
* @deprecated since 1.0 see http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Gadget.xml#rfc.section.A.46.
*/
opensocial.Person.Field = {
/**
* A string ID that can be permanently associated with this person.
* @member opensocial.Person.Field
*/
ID: 'id',
/**
* A opensocial.Name object containing the person's name.
* @member opensocial.Person.Field
*/
NAME: 'name',
/**
* A String representing the person's nickname.
* @member opensocial.Person.Field
*/
NICKNAME: 'nickname',
/**
* Person's photo thumbnail URL, specified as a string.
* This URL must be fully qualified. Relative URLs will not work in gadgets.
* @member opensocial.Person.Field
*/
THUMBNAIL_URL: 'thumbnailUrl',
/**
* Person's profile URL, specified as a string.
* This URL must be fully qualified. Relative URLs will not work in gadgets.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
PROFILE_URL: 'profileUrl',
/**
* Person's current location, specified as an
* Address.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
CURRENT_LOCATION: 'currentLocation',
/**
* Addresses associated with the person, specified as an Array of
* Addresses.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
ADDRESSES: 'addresses',
/**
* Emails associated with the person, specified as an Array of
* Emails.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
EMAILS: 'emails',
/**
* Phone numbers associated with the person, specified as an Array of
* Phones.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
PHONE_NUMBERS: 'phoneNumbers',
/**
* A general statement about the person, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
ABOUT_ME: 'aboutMe',
/**
* Person's status, headline or shoutout, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
STATUS: 'status',
/**
* Person's profile song, specified as an opensocial.Url.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
PROFILE_SONG: 'profileSong',
/**
* Person's profile video, specified as an opensocial.Url.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
PROFILE_VIDEO: 'profileVideo',
/**
* Person's gender, specified as an opensocial.Enum with the enum's
* key referencing opensocial.Enum.Gender.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
GENDER: 'gender',
/**
* Person's sexual orientation, specified as a string.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
SEXUAL_ORIENTATION: 'sexualOrientation',
/**
* Person's relationship status, specified as a string.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
RELATIONSHIP_STATUS: 'relationshipStatus',
/**
* Person's age, specified as a number.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
AGE: 'age',
/**
* Person's date of birth, specified as a Date object.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
DATE_OF_BIRTH: 'dateOfBirth',
/**
* Person's body characteristics, specified as an opensocial.BodyType.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
BODY_TYPE: 'bodyType',
/**
* Person's ethnicity, specified as a string.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
ETHNICITY: 'ethnicity',
/**
* Person's smoking status, specified as an opensocial.Enum with the enum's
* key referencing opensocial.Enum.Smoker.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
SMOKER: 'smoker',
/**
* Person's drinking status, specified as an opensocial.Enum with the enum's
* key referencing opensocial.Enum.Drinker.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
DRINKER: 'drinker',
/**
* Description of the person's children, specified as a string.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
CHILDREN: 'children',
/**
* Description of the person's pets, specified as a string.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
PETS: 'pets',
/**
* Description of the person's living arrangement, specified as a string.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
LIVING_ARRANGEMENT: 'livingArrangement',
/**
* Person's time zone, specified as the difference in minutes between
* Greenwich Mean Time (GMT) and the user's local time. See
* Date.getTimezoneOffset() in javascript for more details on this format.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
TIME_ZONE: 'timeZone',
/**
* List of the languages that the person speaks as ISO 639-1 codes,
* specified as an Array of strings.
* Container support for this field is OPTIONAL.
* @member opensocial.Person.Field
*/
LANGUAGES_SPOKEN: 'languagesSpoken',
/**
* Jobs the person has held, specified as an Array of
* Organizations.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
JOBS: 'jobs',
/**
* Person's favorite jobs, or job interests and skills, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
JOB_INTERESTS: 'jobInterests',
/**
* Schools the person has attended, specified as an Array of
* Organizations.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
SCHOOLS: 'schools',
/**
* Person's interests, hobbies or passions, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
INTERESTS: 'interests',
/**
* URLs related to the person, their webpages, or feeds. Specified as an
* Array of opensocial.Url.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
URLS: 'urls',
/**
* Person's favorite music, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
MUSIC: 'music',
/**
* Person's favorite movies, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
MOVIES: 'movies',
/**
* Person's favorite TV shows, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
TV_SHOWS: 'tvShows',
/**
* Person's favorite books, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
BOOKS: 'books',
/**
* Person's favorite activities, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
ACTIVITIES: 'activities',
/**
* Person's favorite sports, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
SPORTS: 'sports',
/**
* Person's favorite heroes, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
HEROES: 'heroes',
/**
* Person's favorite quotes, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
QUOTES: 'quotes',
/**
* Person's favorite cars, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
CARS: 'cars',
/**
* Person's favorite food, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
FOOD: 'food',
/**
* Person's turn ons, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
TURN_ONS: 'turnOns',
/**
* Person's turn offs, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
TURN_OFFS: 'turnOffs',
/**
* Arbitrary tags about the person, specified as an Array of strings.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
TAGS: 'tags',
/**
* Person's comments about romance, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
ROMANCE: 'romance',
/**
* What the person is scared of, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
SCARED_OF: 'scaredOf',
/**
* Describes when the person is happiest, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
HAPPIEST_WHEN: 'happiestWhen',
/**
* Person's thoughts on fashion, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
FASHION: 'fashion',
/**
* Person's thoughts on humor, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
HUMOR: 'humor',
/**
* Person's statement about who or what they are looking for, or what they are
* interested in meeting people for. Specified as an Array of opensocial.Enum
* with the enum's key referencing opensocial.Enum.LookingFor.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
LOOKING_FOR: 'lookingFor',
/**
* Person's relgion or religious views, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
RELIGION: 'religion',
/**
* Person's political views, specified as a string.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
POLITICAL_VIEWS: 'politicalViews',
/**
* A boolean indicating whether the person has used the current app.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
HAS_APP: 'hasApp',
/**
* Person's current network status. Specified as an Enum with the enum's
* key referencing opensocial.Enum.Presence.
* Container support for this field is OPTIONAL.
*
* @member opensocial.Person.Field
*/
NETWORK_PRESENCE: 'networkPresence'
};
/**
* Gets an ID that can be permanently associated with this person.
*
* @return {string} The ID.
* @deprecated since 1.0 see http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Gadget.xml#rfc.section.A.45.1.4.
*/
opensocial.Person.prototype.getId = function() {
return this.getField(opensocial.Person.Field.ID);
};
var ORDERED_NAME_FIELDS_ = [
opensocial.Name.Field.HONORIFIC_PREFIX,
opensocial.Name.Field.GIVEN_NAME,
opensocial.Name.Field.FAMILY_NAME,
opensocial.Name.Field.HONORIFIC_SUFFIX,
opensocial.Name.Field.ADDITIONAL_NAME];
/**
* Gets a text display name for this person; guaranteed to return
* a useful string.
*
* @return {string} The display name.
* @deprecated since 1.0 see http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Gadget.xml#rfc.section.A.45.1.2.
*/
opensocial.Person.prototype.getDisplayName = function() {
var name = this.getField(opensocial.Person.Field.NAME);
if (name) {
// Try unstructured field first
var unstructured = name.getField(opensocial.Name.Field.UNSTRUCTURED);
if (unstructured) {
return unstructured;
}
// Next try to construct the name from the individual components
var fullName = '';
for (var i = 0; i < ORDERED_NAME_FIELDS_.length; i++) {
var nameValue = name.getField(ORDERED_NAME_FIELDS_[i]);
if (nameValue) {
fullName += nameValue + ' ';
}
}
return fullName.replace(/^\s+|\s+$/g, '');
}
// Finally, try the nickname field
return this.getField(opensocial.Person.Field.NICKNAME);
};
/**
* Gets data for this person that is associated with the specified key.
*
* @param {string} key The key to get data for;
* keys are defined in
* Person.Field.
* @param {Object.=}
* opt_params Additional
* params
* to pass to the request.
* @return {string} The data.
* @deprecated since 1.0 see http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Gadget.xml#rfc.section.A.45.1.3.
*/
opensocial.Person.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
};
/**
* Gets the app data for this person that is associated with the specified
* key.
*
* @param {string} key The key to get app data for.
* @return {string} The corresponding app data.
* @deprecated since 1.0 see http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Gadget.xml#rfc.section.A.45.1.1.
*/
opensocial.Person.prototype.getAppData = function(key) {
};
/**
* Returns true if this person object represents the currently logged in user.
*
* @return {boolean} True if this is the currently logged in user;
* otherwise, false.
* @deprecated since 1.0 see http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Gadget.xml#rfc.section.A.45.1.6.
*/
opensocial.Person.prototype.isViewer = function() {
return !!this.isViewer_;
};
/**
* Returns true if this person object represents the owner of the current page.
*
* @return {boolean} True if this is the owner of the page;
* otherwise, false.
* @deprecated since 1.0 see http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Gadget.xml#rfc.section.A.45.1.5.
*/
opensocial.Person.prototype.isOwner = function() {
return !!this.isOwner_;
};
© 2015 - 2025 Weber Informatics LLC | Privacy Policy