Namespace opensocial.IdSpec.Field
All of the fields that id specs can have.
See also: opensocial.IdSpec.getField()
Defined in: opensocial.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
opensocial.IdSpec.Field.GROUP_ID
A string representing the group id or one of the
opensocial.IdSpec.GroupId values.
|
| <static> |
opensocial.IdSpec.Field.NETWORK_DISTANCE
An optional numeric parameter, used to specify how many "hops"
are allowed between two people still considered part of the
same group.
|
| <static> |
opensocial.IdSpec.Field.USER_ID
A string or an array of strings representing the user id.
|
Field Detail
<static>
opensocial.IdSpec.Field.GROUP_ID
A string representing the group id or one of the
opensocial.IdSpec.GroupId values. Defaults to SELF.
<static>
opensocial.IdSpec.Field.NETWORK_DISTANCE
An optional numeric parameter, used to specify how many "hops"
are allowed between two people still considered part of the
same group.
Defaults to 1 (they must be the same person or
directly be connected by the group).
Not all containers will support networkDistances greater than 1.
<static>
opensocial.IdSpec.Field.USER_ID
A string or an array of strings representing the user id. Can be
one of the opensocial.IdSpec.PersonId values.