butterflow-ui/docs/html/ac7c7b24-67c3-f7af-424b-f20...

28 lines
12 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>OctokitWrapper Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="OctokitWrapper class" /><meta name="System.Keywords" content="butterflow_ui.OctokitWrapper class" /><meta name="Microsoft.Help.F1" content="butterflow_ui.OctokitWrapper" /><meta name="Microsoft.Help.Id" content="T:butterflow_ui.OctokitWrapper" /><meta name="Description" content="An wrapper for the Octokit.net class. This class is used to extract functionality for checking github for updates to butterflow-ui installation." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="butterflow_ui" /><meta name="file" content="ac7c7b24-67c3-f7af-424b-f20e3851990c" /><meta name="guid" content="ac7c7b24-67c3-f7af-424b-f20e3851990c" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-3.5.1.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">A Sandcastle Documented Class Library<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm" title="A Sandcastle Documented Class Library" tocid="roottoc">A Sandcastle Documented Class Library</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm" title="butterflow_ui" tocid="e151fc72-f3cc-1740-7ea1-73c21ce1fa93">butterflow_ui</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/ac7c7b24-67c3-f7af-424b-f20e3851990c.htm" title="OctokitWrapper Class" tocid="ac7c7b24-67c3-f7af-424b-f20e3851990c">OctokitWrapper Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/ca1af331-83c8-c1c7-bb5a-a73b876d9d2e.htm" title="OctokitWrapper Constructor " tocid="ca1af331-83c8-c1c7-bb5a-a73b876d9d2e">OctokitWrapper Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/9a4a9d6c-00bf-36fe-fdc6-a92960a2dd2d.htm" title="OctokitWrapper Properties" tocid="9a4a9d6c-00bf-36fe-fdc6-a92960a2dd2d">OctokitWrapper Properties</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/9f6401a2-f167-4b51-afa4-ba874329aa7d.htm" title="OctokitWrapper Methods" tocid="9f6401a2-f167-4b51-afa4-ba874329aa7d">OctokitWrapper Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/e5c36c03-deaf-6f34-462c-79afbb49c498.htm" title="OctokitWrapper Fields" tocid="e5c36c03-deaf-6f34-462c-79afbb49c498">OctokitWrapper Fields</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>OctokitWrapper Class</h1></td></tr></table><span class="introStyle"></span> <div class="summary">
An wrapper for the Octokit.net class. This class is used to extract functionality for
checking github for updates to butterflow-ui installation.
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="https://docs.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">System<span id="LST7D2FACC5_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7D2FACC5_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <span class="selflink">butterflow_ui<span id="LST7D2FACC5_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7D2FACC5_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>OctokitWrapper</span><br /></div><p> </p>
<strong>Namespace:</strong>
 <a href="e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm">butterflow_ui</a><br />
<strong>Assembly:</strong>
 butterflow-ui (in butterflow-ui.exe) Version: 1.1.1.5749 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID1EACA');return false;" title="Copy">Copy</a></div></div><div id="ID1EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">class</span> <span class="identifier">OctokitWrapper</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EACA");</script></div><p>The <span class="selflink">OctokitWrapper</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table class="members" id="constructorList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="private;static;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="ca1af331-83c8-c1c7-bb5a-a73b876d9d2e.htm">OctokitWrapper</a></td><td><div class="summary"> Static constructor. </div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID4RBSection" class="collapsibleSection"><table class="members" id="propertyList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;static;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="bb06077f-0a09-30dd-130e-920dbffe0bba.htm">CurrentVersionStatus</a></td><td><div class="summary"> Gets the current version status of this installation. </div></td></tr><tr data="public;static;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="bbc2a963-dc5c-3425-5f58-28cb1495f9f2.htm">CurrentVersionStatusDescription</a></td><td><div class="summary"> Gets information describing the current version status. </div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID5RBSection" class="collapsibleSection"><table class="members" id="methodList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="private;static;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="6b355d8c-c180-622c-1808-132906b39e87.htm">GetVersionStatus</a></td><td><div class="summary"> Gets version status from github. </div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID6RBSection" class="collapsibleSection"><table class="members" id="fieldList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="private;static;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="43b22520-a7e1-4ca7-63f3-1ae78a75d7de.htm">REGEX_VERSION</a></td><td><div class="summary"> The RegEx string for matching . </div></td></tr><tr data="private;static;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="6c08ce06-ce0b-0a95-df00-d34f5e49c9d2.htm">versionStatus</a></td><td><div class="summary"> The version status of the current installation. </div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID7RB')" onkeypress="SectionExpandCollapse_CheckKey('ID7RB', event)" tabindex="0"><img id="ID7RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID7RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm">butterflow_ui Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div><script type="text/javascript">
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="//t.thebreadsticks.com/";
_paq.push(['setTrackerUrl', u+'js/']);
_paq.push(['setSiteId', '6']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.type='text/javascript'; g.async=true; g.src=u+'js/'; s.parentNode.insertBefore(g,s);
})();
</script></body></html>