l.c.i.w.IGitRef(IGitRefView, IGitRefEdit) : interface documentation

Part of lp.code.interfaces.webservice View In Hierarchy

A reference in a Git repository.

Inherited from IGitRefView:

Attribute repository_url The repository URL, if this is a reference in a remote repository.
Attribute name A shortened version of the full path to this reference, with any leading refs/heads/ removed.
Attribute url_quoted_name The reference name, quoted for use in URLs.
Choice object_type Undocumented
Attribute author The author of the commit pointed to by this reference.
Datetime author_date Undocumented
Attribute committer The committer of the commit pointed to by this reference.
Datetime committer_date Undocumented
Text commit_message Undocumented
TextLine display_name Display name of the reference.
Attribute displayname Copy of display_name for IHasMergeProposals views.
TextLine commit_message_first_line Undocumented
Attribute identity The identity of this reference. This will be the shortened path to the containing repository, plus a colon, plus the reference path with any leading refs/heads/ removed; for example, launchpad:master.
Attribute unique_name The unique name of this reference. This will be the unique name of the containing repository, plus a colon, plus the reference path with any leading refs/heads/ removed; for example, ~launchpad-pqm/launchpad:master.
Attribute repository_type The type of the repository containing this reference.
Attribute owner The owner of the repository containing this reference.
Attribute target The target of the repository containing this reference.
Attribute namespace The namespace of the repository containing this reference, as an IGitNamespace.
Method getCodebrowseUrl Construct a browsing URL for this Git reference.
Method getCodebrowseUrlForRevision Construct a browsing URL for this Git at the given commit
Attribute information_type The type of information contained in the repository containing this reference.
Bool private The repository containing this reference is visible only to its subscribers.
Method visibleByUser Can the specified user see the repository containing this
Method transitionToInformationType Set the information type for this reference's repository.
Attribute reviewer The person or exclusive team that is responsible for reviewing proposals and merging into this reference.
Attribute code_reviewer The reviewer if set, otherwise the owner of the repository containing this reference.
Method isPersonTrustedReviewer Return true if the reviewer is a trusted reviewer.
Attribute subscriptions GitSubscriptions associated with the repository containing this reference.
Attribute subscribers Persons subscribed to the repository containing this reference.
Method subscribe Subscribe this person to the repository containing this reference.
Method getSubscription Return the GitSubscription for this person.
Method unsubscribe Remove the person's subscription to this reference's repository.
Method getNotificationRecipients Return a complete INotificationRecipientSet instance.
Attribute landing_targets A collection of the merge proposals where this reference is the source.
Attribute landing_candidates A collection of the merge proposals where this reference is the target.
Method getPrecachedLandingTargets Return precached landing targets.
Method getPrecachedLandingCandidates Return precached landing candidates.
Method addLandingTarget Create a new BranchMergeProposal with this reference as the source.
Method createMergeProposal Create a new BranchMergeProposal with this reference as the source.
Method getMergeProposals Return matching BranchMergeProposals.
Method getDependentMergeProposals Return BranchMergeProposals dependent on merging this reference.
Attribute pending_updates Whether there are recent changes in this repository that have not yet been scanned.
Method getCommits Get commit information from this reference.
Method getLatestCommits Return a specific number of the latest commits in this ref.
Attribute has_commits Whether this reference has any commits.
Method getBlob Get a blob by file name from this reference.
Method getLatestScanJob Return the last IGitRefScanJobSource for the repository
Method rescan Force a rescan of the repository

Inherited from IGitRefEdit:

Method getGrants Get the access grants specific to this reference.
Method setGrants Set the access grants specific to this reference.
Method checkPermissions Check a person's permissions on this reference.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.