gedcomx-php-client
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rs
          • Client
            • FamilyTree
            • Helpers
            • Memories
            • Util
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rs
      • Client
        • Exception
        • Options
        • Util
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • DiscussionsState
  • DiscussionState
  • FamilySearchClient
  • FamilySearchCollectionState
  • FamilySearchPlaceDescriptionState
  • FamilySearchPlaces
  • FamilySearchPlaceState
  • FamilySearchSourceDescriptionState
  • FamilySearchStateFactory
  • PersonMatchResultsState
  • PersonMergeState
  • PersonNonMatchesState
  • Rel
  • UserHistoryState
  • UserState

Class Rel

A collection of rel links to assist in looking up resource links. When a resource is consumed, it typically returns a set of hypermedia links that enable additional actions on the resource. Whileresources typically provide links, not all links will be available on a given resource (such as paging links on a person resource). The links exposed in this class are a set of predefined constants, which can be used to determine if a link is available on a given resource.

Class Rel

Gedcomx\Rs\Client\Rel
Extended by Gedcomx\Extensions\FamilySearch\Rs\Client\Rel
Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client
Package: Gedcomx\Extensions\FamilySearch\Rs\Client
Located at Extensions/FamilySearch/Rs/Client/Rel.php

Constants summary

string CHANGE_HISTORY

A link that points to the change history resource.

A link that points to the change history resource.

# "change-history"
string COMMENT

A link that points to the comment resource.

A link that points to the comment resource.

# "comment"
string COMMENTS

A link that points to the comments resource.

A link that points to the comments resource.

# "comments"
string CURRENT_USER

A link that points to the current user resource.

A link that points to the current user resource.

# "current-user"
string CURRENT_USER_HISTORY

A link that points to the current user history resource.

A link that points to the current user history resource.

# "current-user-history"
string DISCUSSIONS

A link that points to the discussions resource.

A link that points to the discussions resource.

# "discussions"
string MERGE

A link that points to the merge resource.

A link that points to the merge resource.

# "merge"
string MERGE_MIRROR

A link that points to the merge mirror resource.

A link that points to the merge mirror resource.

# "merge-mirror"
string NORMALIZED_DATE

A link that points to the normalized date resource.

A link that points to the normalized date resource.

# "normalized-date"
string NOT_A_MATCHES

A link that points to the not a matches resource.

A link that points to the not a matches resource.

# "non-matches"
string NOT_A_MATCH

A link that points to the not a match resource.

A link that points to the not a match resource.

# "non-match"
string PERSON_MATCHES_QUERY

A link that points to the person matches query resource.

A link that points to the person matches query resource.

# "person-matches-query"
string PORTRAIT

A link that points to the portrait resource.

A link that points to the portrait resource.

# "portrait"
string PORTRAITS

A link that points to the portraits resource.

A link that points to the portraits resource.

# "portraits"
string RESTORE

A link that points to the restore resource.

A link that points to the restore resource.

# "restore"
string FATHER_ROLE

A link that points to the father role resource.

A link that points to the father role resource.

# "father-role"
string MOTHER_ROLE

A link that points to the mother role resource.

A link that points to the mother role resource.

# "mother-role"
string PERSON_WITH_RELATIONSHIPS

A link that points to the person with relationships resource.

A link that points to the person with relationships resource.

# "person-with-relationships"
string PREFERRED_SPOUSE_RELATIONSHIP

A link that points to the preferred spouse relationship resource.

A link that points to the preferred spouse relationship resource.

# "preferred-spouse-relationship"
string PREFERRED_PARENT_RELATIONSHIP

A link that points to the preferred parent relationship resource.

A link that points to the preferred parent relationship resource.

# "preferred-parent-relationship"

Constants inherited from Gedcomx\Rs\Client\Rel

AGENT, ANCESTRY, ARTIFACTS, CHILDREN, CHILD_RELATIONSHIPS, COLLECTION, CONCLUSION, CONCLUSIONS, CURRENT_USER_PERSON, CURRENT_USER_RESOURCES, DESCENDANCY, DESCRIPTION, DISCUSSION_REFERENCE, DISCUSSION_REFERENCES, EVIDENCE_REFERENCE, EVIDENCE_REFERENCES, FIRST, IMAGE_RECORDS, LAST, MATCHES, MEDIA_REFERENCE, MEDIA_REFERENCES, NEXT, NOTE, NOTES, OAUTH2_AUTHORIZE, OAUTH2_TOKEN, PARENTS, PARENT_RELATIONSHIPS, PERSON, PERSON1, PERSON2, PERSONS, PERSON_SEARCH, PLACE, PLACE_DESCRIPTION, PLACE_GROUP, PLACE_SEARCH, PLACE_TYPE, PLACE_TYPES, PLACE_TYPE_GROUP, PLACE_TYPE_GROUPS, PREV, PREVIOUS, PROFILE, RECORD, RECORDS, RELATIONSHIP, RELATIONSHIPS, SELF, SOURCE_DESCRIPTIONS, SOURCE_REFERENCE, SOURCE_REFERENCES, SOURCE_REFERENCES_QUERY, SPOUSES, SPOUSE_RELATIONSHIPS, SUBCOLLECTIONS

gedcomx-php-client API documentation generated by ApiGen