33
44namespace GitHub . Services
55{
6+ /// <summary>
7+ /// Information used to map betwen a GitHub URL and some other context. This might be used to navigate
8+ /// between a GitHub URL and the location a repository file. Alternatively it might be used to map between
9+ /// the line a in a blame view and GitHub URL.
10+ /// </summary>
611 public class GitHubContext
712 {
13+ /// <summary>
14+ /// The owner of a repository.
15+ /// </summary>
816 public string Owner { get ; set ; }
17+ /// <summary>
18+ /// The name of a repository.
19+ /// </summary>
920 public string RepositoryName { get ; set ; }
21+ /// <summary>
22+ /// The host of a repository ("github.com" or a GitHub Enterprise host).
23+ /// </summary>
1024 public string Host { get ; set ; }
25+ /// <summary>
26+ /// The name of a branch stored on GitHub (not the local branch name).
27+ /// </summary>
1128 public string BranchName { get ; set ; }
1229 /// <summary>
1330 /// Like a tree-ish but with ':' changed to '/' (e.g. "master/src" not "master:src").
1431 /// </summary>
1532 public string TreeishPath { get ; set ; }
33+ /// <summary>
34+ /// The name of a file on GitHub.
35+ /// </summary>
1636 public string BlobName { get ; set ; }
37+ /// <summary>
38+ /// A PR number if this context represents a PR.
39+ /// </summary>
1740 public int ? PullRequest { get ; set ; }
41+ /// <summary>
42+ /// An issue number if this context represents an issue.
43+ /// </summary>
1844 public int ? Issue { get ; set ; }
45+ /// <summary>
46+ /// The line number in a file.
47+ /// </summary>
1948 public int ? Line { get ; set ; }
49+ /// <summary>
50+ /// The end line number if this context represents a range.
51+ /// </summary>
2052 public int ? LineEnd { get ; set ; }
53+ /// <summary>
54+ /// The source Url of the context (when context originated from a URL).
55+ /// </summary>
2156 public UriString Url { get ; set ; }
57+ /// <summary>
58+ /// The type of context if known (blob, blame etc).
59+ /// </summary>
2260 public LinkType LinkType { get ; set ; }
2361 }
24- }
62+ }
0 commit comments