SAY MEDIA > WWW-TypePad > WWW::TypePad::Relationships

Download:
WWW-TypePad-0.4002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

WWW::TypePad::Relationships - Relationships API methods

METHODS ^

get
  my $res = $tp->relationships->get($id);

Get basic information about the selected relationship.

Returns Relationship which contains following properties.

id

(string) A URI that serves as a globally unique identifier for the relationship.

urlId

(string) A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same relationship is returned in response to different requests, and as a mapping key for an application's local data store.

source

(Entity) The source entity of the relationship.

target

(Entity) The target entity of the relationship.

status

(RelationshipStatus) An object describing all the types of relationship that currently exist between the source and target objects.

created

(map<datetime>) A mapping of the relationship types present between the source and target objects to the times those types of relationship were established. The keys of the map are the relationship type URIs present in the relationship's M<status> property; the values are W3CDTF timestamps for the times those relationship edges were created.

get_status
  my $res = $tp->relationships->get_status($id);

Get the status information for the selected relationship, including its types.

Returns RelationshipStatus which contains following properties.

types

(array<string>) A list of relationship type URIs describing the types of the related relationship.

put_status
  my $res = $tp->relationships->put_status($id);

Change the status information for the selected relationship, including its types.

Returns RelationshipStatus which contains following properties.

types

(array<string>) A list of relationship type URIs describing the types of the related relationship.

syntax highlighting: