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 UserState

The UserState exposes management functions for a user.

Class UserState

Gedcomx\Rs\Client\GedcomxApplicationState
Extended by Gedcomx\Rs\Client\CollectionState
Extended by Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState
Extended by Gedcomx\Extensions\FamilySearch\Rs\Client\UserState
Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client
Package: Gedcomx\Extensions\FamilySearch\Rs\Client
Located at Extensions/FamilySearch/Rs/Client/UserState.php

Methods summary

public Gedcomx\Extensions\FamilySearch\Platform\Users\User.php|null
# getUser( )

Gets the user represented by the current state instance.

Gets the user represented by the current state instance.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Users\User.php|null
public Gedcomx\Rs\Client\SourceDescriptionState|null
# readArtifacts( Gedcomx\Extensions\FamilySearch\Rs\Client\StateTransitionOption $option = null )

Read any artifacts created by this user

Read any artifacts created by this user

Parameters

$option

Returns

Gedcomx\Rs\Client\SourceDescriptionState|null

Methods inherited from Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

__construct(), addDiscussion(), addProcessingTime(), getCollection(), normalizeDate(), readCurrentUser(), readCurrentUserHistory(), readDiscussions(), readPerson(), searchForPersonMatches()

Methods inherited from Gedcomx\Rs\Client\CollectionState

AddParentChildRelationship(), addArtifact(), addCollection(), addPerson(), addRecord(), addRelationship(), addRelationships(), addSourceDescription(), addSpouseRelationship(), readCollection(), readPersonForCurrentUser(), readPersons(), readRecords(), readRelationships(), readResourcesOfCurrentUser(), readSourceDescriptions(), readSubcollections(), searchForPersons(), update()

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState

authenticateViaOAuth2AuthCode(), authenticateViaOAuth2ClientCredentials(), authenticateViaOAuth2Password(), authenticateViaOAuth2WithoutCredentials(), authenticateWithAccessToken(), delete(), generateClientSecret(), get(), getAccessToken(), getClient(), getETag(), getEntity(), getHeader(), getHeaders(), getLastEmbeddedRequest(), getLastEmbeddedResponse(), getLastModified(), getLink(), getLinks(), getRequest(), getResourceReference(), getResponse(), getSelfRel(), getSelfUri(), getStatus(), getUri(), hasClientError(), hasError(), hasServerError(), hasStatus(), head(), ifSuccessful(), inject(), isAuthenticated(), loadAllEmbeddedResources(), logout(), options(), post(), put(), readAttributableContributor(), readContributor(), readReferenceContributor(), send()

gedcomx-php-client API documentation generated by ApiGen