MySpace Developer Platform

A Place For Developers

Welcome Developers!

Welcome!

Data Availability
JsDoc:
Library: MyOpenSpace.js
Overview
Interface for container and associated classes; everything needed to query/update MySpace API data via OpenSocial interface.
  • source: MyOpenSpace.js
  • desc: Copyright 2007 Fox Interactive Media
  • author: mnewbould@myspace.com (Max Newbould)
  • author: crussell@myspace.com (Chad Russell)
Constructors
MyOpenSpace.MySpaceContainer()
The MySpace container class, extends opensocial.Container. Use opensocial.Container.get() to retrieve this singleton.
methods
  • newPerson(opt_params, opt_isViewer, opt_isOwner)
  • newResponseItem(originalDataRequest, data, opt_errorCode, opt_errorMessage)
Namespaces
MyOpenSpace.Person.Field
The fields for the extended MyOpenSpace.Person
properties
MyOpenSpace.Album.Field
The fields for MyOpenSpace.Album
properties
MyOpenSpace.Video.Field
The fields for MyOpenSpace.Video
properties
MyOpenSpace.Photo.Field
The fields for MyOpenSpace.Photo
properties
MyOpenSpace.Group
Enum for groups of items, extends opensocial.DataRequest.Group
properties
MyOpenSpace.RequestType
Enumerates the types of requests that can be made
properties
MyOpenSpace.DataRequest.FilterType
Enumerates the extended filter types
properties
MyOpenSpace.Environment.ObjectType
properties
Functions
MyOpenSpace.Album.getField(key)
Returns the field specified by key
parameters
String key The key to search by
returns
MyOpenSpace.Album, undefined The album if found, nothing otherwise.
MyOpenSpace.Video.getField(key)
Returns the field specified by key
parameters
String key The key to search by
returns
MyOpenSpace.Video, undefined The video if found, nothing otherwise.
MyOpenSpace.Photo.getField(key)
Returns the field specified by key
parameters
String key The key to search by
returns
MyOpenSpace.Photo, undefined The photo if found, nothing otherwise.
MyOpenSpace.MySpaceContainer.makeRequest(url, callback, Additional)
makeRequest implementation using proxy Fetches content from the provided URL and feeds that content into the callback function
parameters
String url The URL where content is located
Function callback The function to call with the data returned from url
opensocial.ContentRequestParameters Additional parameters to pass to the request
MyOpenSpace.MySpaceContainer.getEnvironment()
Returns the container's environment object.
returns
opensocial.Environment
MyOpenSpace.MySpaceContainer.newPerson(opt_params, opt_isViewer, opt_isOwner)
Returns a new MyOpenSpace.Person instance
parameters
Map<opensocial.DataRequest.PeopleRequestFields> opt_params Optional parameters specified when creating the person.
Boolean opt_isViewer True if this is the viewer of the page otherwise, false.
Boolean opt_isOwner True if this is the owner of the page otherwise, false.
returns
MyOpenSpace.Person The person object
MyOpenSpace.MySpaceContainer.newAlbum(opt_params)
Returns a new MyOpenSpace.Album instance
parameters
undefined opt_params Unused at this time.
returns
MyOpenSpace.Album The album object
MyOpenSpace.MySpaceContainer.newVideo(opt_params)
Returns a new MyOpenSpace.Video instance
parameters
undefined opt_params Unused at this time.
returns
MyOpenSpace.Video The album object
MyOpenSpace.MySpaceContainer.newPhoto(opt_params)
Returns a new MyOpenSpace.Photo instance
parameters
undefined opt_params Unused at this time.
returns
MyOpenSpace.Photo The photo object
MyOpenSpace.MySpaceContainer.newDataRequest()
Returns a new opensocial.DataRequest instance, which is overridden locally
returns
opensocial.DataRequest The data request object
MyOpenSpace.MySpaceContainer.newResponseItem(originalDataRequest, data, opt_errorCode, opt_errorMessage)
Returns a new opensocial.ResponseItem instance
parameters
opensocial.DataRequest originalDataRequest The ID of the photo to fetch
Object, null data The object retrieved, can be any entity, or null if nothing was found.
String opt_errorCode A code defining the error that occurred, if any.
String opt_errorMessage A message detailing the error that occurred, if any.
returns
opensocial.ResponseItem The response item object
MyOpenSpace.MySpaceContainer.newFetchPersonRequest(id, opt_params)
Creates an object to be used when sending to the server.
parameters
String id The ID (VIEWER or OWNER) of the person.
undefined opt_params Not used at this time.
returns
Object A request object.
MyOpenSpace.MySpaceContainer.newFetchPhotoRequest(id, photo_id, opt_params)
Creates an object to be used when sending to the server.
parameters
String id The ID (VIEWER or OWNER) of the person who owns the photo
Number photo_id The ID of the photo to fetch
undefined opt_params Not used at this time.
returns
Object A request object
MyOpenSpace.MySpaceContainer.newFetchPhotosRequest(id, opt_params)
Creates an object to be used when sending to the server
parameters
String id The ID (VIEWER or OWNER) of the person who owns the photos
Map<opensocial.DataRequest.PeopleRequestFields.FIRST, opensocial.DataRequest.PeopleRequestFields.MAX> opt_params Optional parameters specified when creating the photos.
returns
Object A request object
MyOpenSpace.MySpaceContainer.newFetchAlbumRequest(id, album_id, opt_params)
Creates an object to be used when sending to the server
parameters
String id The ID (VIEWER or OWNER) of the person who owns the album
Number album_id The ID of the photo to fetch
undefined opt_params Not used at this time.
returns
Object A request object
MyOpenSpace.MySpaceContainer.newFetchAlbumsRequest(id, opt_params)
Creates an object to be used when sending to the server
parameters
String id The ID (VIEWER or OWNER) of the person who owns the albums
Map<opensocial.DataRequest.PeopleRequestFields.FIRST, opensocial.DataRequest.PeopleRequestFields.MAX> opt_params Optional parameters specified when creating the albums.
returns
Object A request object
MyOpenSpace.MySpaceContainer.newFetchVideoRequest(id, video_id, opt_params)
Creates an object to be used when sending to the server
parameters
String id The ID (VIEWER or OWNER) of the person who owns the album
Number video_id The ID of the photo to fetch
undefined opt_params Not used at this time.
returns
Object A request object
MyOpenSpace.MySpaceContainer.newFetchVideosRequest(id, opt_params)
Creates an object to be used when sending to the server
parameters
String id The ID (VIEWER or OWNER) of the person who owns the albums
Map<opensocial.DataRequest.PeopleRequestFields.FIRST, opensocial.DataRequest.PeopleRequestFields.MAX> opt_params Optional parameters specified when creating the videos.
returns
Object A request object
MyOpenSpace.MySpaceContainer.newFetchPeopleRequest(idSpec, opt_params)
Creates an item to request friends from the server. When processed, returns an opensocial.Collection<MyOpenSpace.Person> object.
parameters
Array.<String>, String idSpec An ID reference used to specify which people to fetch; the supported keys VIEWER_FRIENDS or OWNER_FRIENDS.
Map.<opensocial.DataRequest.PeopleRequestFields opt_params Additional opensocial.DataRequest.PeopleRequestFields params to pass to the request.
returns
Object A request object.
Objects
MyOpenSpace.DefaultPageSize
Defines the default page size for paginated requests. Used as max/default for MAX of PeopleRequestFields
MyOpenSpace.Person.Field.CITY
A string representing a Person's city of residence.
MyOpenSpace.Person.Field.REGION
A string representing a Person's state/province/region of residence.
MyOpenSpace.Person.Field.POSTALCODE
A string representing a Person's zip/postal code.
MyOpenSpace.Person.Field.COUNTRY
A string representing a Person's country of residence.
MyOpenSpace.Person.Field.HOMETOWN
A string representing a Person's city of birth.
MyOpenSpace.Person.Field.AGE
A number representing a Person's age.
MyOpenSpace.Person.Field.GENDER
A string representing a Person's gender.
MyOpenSpace.Person.Field.ABOUT
A string representing non-specific details about a Person.
MyOpenSpace.Person.Field.CULTURE
A string representing a Person's locale.
MyOpenSpace.Person.Field.MARITAL_STATUS
A string representing a Person's marital status.
MyOpenSpace.Person.Field.INTERESTS
A string representing a Person's non-specific interests.
MyOpenSpace.Person.Field.MUSIC
A string representing a Person's interests in music.
MyOpenSpace.Person.Field.MOVIES
A string representing a Person's interests in movies.
MyOpenSpace.Person.Field.TELEVISION
A string representing a Person's interests in television.
MyOpenSpace.Person.Field.BOOKS
A string representing a Person's interests in books.
MyOpenSpace.Person.Field.HEROES
A string representing a Person's heroes.
MyOpenSpace.Person.Field.HEADLINE
A string representing a Person's headline or shoutout.
MyOpenSpace.Person.Field.OCCUPATION
A string representing a Person's current job and job history.
MyOpenSpace.Person.Field.ZODIAC_SIGN
A string representing a Person's zodiac sign.
MyOpenSpace.Person.Field.MOOD
A string representing a Person's current mood.
MyOpenSpace.Person.Field.STATUS
A string representing a Person's status.
MyOpenSpace.Person.Field.DESIRE_TO_MEET
A string representing a list of people the Person would like to meet.
MyOpenSpace.Album.Field.ALBUM_ID
A number representing an Album's unique identifier.
MyOpenSpace.Album.Field.ALBUM_URI
The RESTFUL URI with which to access the album on the API.
MyOpenSpace.Album.Field.TITLE
The album's title.
MyOpenSpace.Album.Field.LOCATION
The geographic location where the album's pictures were taken.
MyOpenSpace.Album.Field.DEFAULT_IMAGE
A URL for the album's default image.
MyOpenSpace.Album.Field.PRIVACY
A string representing the album's privacy setting, such as "Public" or "Private"
MyOpenSpace.Album.Field.PHOTO_COUNT
An integer representing the total number of photos in the album (not the number of photos actually contained within the current object).
MyOpenSpace.Album.Field.PHOTOS_URI
A RESTFUL URI with which to access the photos contained in the album.
MyOpenSpace.Video.Field.VIDEO_ID
A number representing a Video's unique identifier.
MyOpenSpace.Video.Field.VIDEO_URI
The RESTFUL URI with which to access the video on the API.
MyOpenSpace.Video.Field.TITLE
The video's title.
MyOpenSpace.Video.Field.DATE_CREATED
The date the video was created.
MyOpenSpace.Video.Field.LAST_UPDATE
The date the video was last updated.
MyOpenSpace.Video.Field.MEDIA_TYPE
An integer representing the media type for this video.
MyOpenSpace.Video.Field.THUMB_URI
A URL for the thumbnail image associated with this video.
MyOpenSpace.Video.Field.DESCRIPTION
A description of the video.
MyOpenSpace.Video.Field.MEDIA_STATUS
The current status of the video, such as "ProcessingFailed"
MyOpenSpace.Video.Field.RUN_TIME
The length of the video.
MyOpenSpace.Video.Field.TOTAL_VIEWS
An integer representing the number of views the video has currently received.
MyOpenSpace.Video.Field.TOTAL_COMMENTS
An integer representing the number of comments the video has currently received.
MyOpenSpace.Video.Field.TOTAL_RATING
An integer representing the rating the video has currently received.
MyOpenSpace.Video.Field.TOTAL_VOTES
An integer representing the number of votes the video has currently received.
MyOpenSpace.Video.Field.COUNTRY
A string representing the video's country, in terms of identifying culture, not necessarily geographic location.
MyOpenSpace.Video.Field.LANGUAGE
A string representing the video's language.
MyOpenSpace.Photo.Field.PHOTO_ID
A number representing a Photo's unique identifier.
MyOpenSpace.Photo.Field.PHOTO_URI
The RESTFUL URI with which to access the photo on the API.
MyOpenSpace.Photo.Field.IMAGE_URI
The URL of the photo.
MyOpenSpace.Photo.Field.CAPTION
The photo's caption.
MyOpenSpace.Group.VIEWER_ALBUM
The idSpec for a viewer album.
MyOpenSpace.Group.OWNER_ALBUM
The idSpec for an owner album.
MyOpenSpace.Group.VIEWER_ALBUMS
The idSpec for viewer albums.
MyOpenSpace.Group.OWNER_ALBUMS
The idSpec for owner albums.
MyOpenSpace.Group.VIEWER_VIDEO
The idSpec for a viewer video.
MyOpenSpace.Group.OWNER_VIDEO
The idSpec for an owner video.
MyOpenSpace.Group.VIEWER_VIDEOS
The idSpec for viewer videos.
MyOpenSpace.Group.OWNER_VIDEOS
The idSpec for owner videos.
MyOpenSpace.Group.VIEWER_PHOTO
The idSpec for a viewer photo.
MyOpenSpace.Group.OWNER_PHOTO
The idSpec for an owner photo.
MyOpenSpace.Group.VIEWER_PHOTOS
The idSpec for viewer photos.
MyOpenSpace.Group.OWNER_PHOTOS
The idSpec for owner photos.
MyOpenSpace.RequestType.FETCH_PERSON
Defines an enum for a fetch person request.
MyOpenSpace.RequestType.FETCH_PEOPLE
Defines an enum for a fetch people request.
MyOpenSpace.RequestType.FETCH_FRIENDS
Defines an enum for a fetch friends request.
MyOpenSpace.RequestType.FETCH_GLOBAL_DATA
Defines an enum for a fetch global data request.
MyOpenSpace.RequestType.FETCH_INSTANCE_DATA
Defines an enum for a fetch instance data request.
MyOpenSpace.RequestType.UPDATE_INSTANCE_DATA
Defines an enum for an update instance data request.
MyOpenSpace.RequestType.FETCH_PERSON_DATA
Defines an enum for a fetch person data request.
MyOpenSpace.RequestType.UPDATE_PERSON_DATA
Defines an enum for an update person data request.
MyOpenSpace.RequestType.FETCH_ACTIVITIES
Defines an enum for a fetch activities request.
MyOpenSpace.RequestType.FETCH_ALBUMS
Defines an enum for a fetch albums request.
MyOpenSpace.RequestType.FETCH_ALBUM
Defines an enum for a fetch album request.
MyOpenSpace.RequestType.FETCH_VIDEOS
Defines an enum for a fetch videos request.
MyOpenSpace.RequestType.FETCH_VIDEO
Defines an enum for a fetch video request.
MyOpenSpace.RequestType.FETCH_PHOTOS
Defines an enum for a fetch photos request.
MyOpenSpace.RequestType.FETCH_PHOTO
Defines an enum for a fetch photo request.
MyOpenSpace.DetailType.BASIC
Used internally to map Person requests in order to cache things better, contains basic public information.
MyOpenSpace.DetailType.FULL
Used internally to map Person requests in order to cache things better, contains some private data.
MyOpenSpace.DetailType.EXTENDED
Used internally to map Person requests in order to cache things better, contains full profile data.
MyOpenSpace.DataRequest.FilterType.ONLINE_FRIENDS
The friends that are currently online.
MyOpenSpace.Environment.ObjectType.VIDEO
MyOpenSpace.Environment.ObjectType.PHOTO
MyOpenSpace.Environment.ObjectType.ALBUM
Generated by JsDoc Toolkit 1.4.0 on Mon, 04 Feb 2008 23:41:36 GMT.

About | FAQ | Terms | Privacy | Safety Tips | Contact MySpace | Advertise | MySpace International | MySpace Latino
©2003-2008 MySpace.com. All Rights Reserved.