Skip to content

Commit

Permalink
Updated documentation to reflect latest changes 74fb5fa
Browse files Browse the repository at this point in the history
  • Loading branch information
@AptiviCEO
AptiviCEO committed Aug 20, 2023
1 parent 3201c9b commit 6b2c406
Show file tree
Hide file tree
Showing 59 changed files with 3,974 additions and 7,079 deletions.
132 changes: 77 additions & 55 deletions api/VisualCard.CardTools.html
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class CardTools
| VisualCard API - Eofla Internals </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CardTools
| VisualCard API - Eofla Internals ">
<meta name="generator" content="docfx 2.58.9.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class CardTools
| VisualCard API - Eofla Internals </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CardTools
| VisualCard API - Eofla Internals ">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

<meta property="docfx:rel" content="../">

</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
Expand All @@ -35,7 +34,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
Expand All @@ -49,7 +48,7 @@
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
Expand All @@ -59,7 +58,7 @@
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
Expand All @@ -69,7 +68,7 @@
</div>
</div>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
Expand All @@ -79,39 +78,45 @@
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="VisualCard.CardTools">





<h1 id="VisualCard_CardTools" data-uid="VisualCard.CardTools" class="text-break">Class CardTools
</h1>
</h1>
<div class="markdown level0 summary"><p>Module for VCard management</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div class="level1"><span class="xref">CardTools</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="VisualCard.html">VisualCard</a></h6>
<h6><strong>Assembly</strong>: VisualCard.dll</h6>
<h5 id="VisualCard_CardTools_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class CardTools : object</code></pre>
<pre><code class="lang-csharp hljs">public static class CardTools</code></pre>
</div>
<h3 id="methods">Methods
</h3>


</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_CardTools_GetCardParsers_System_IO_StreamReader_.md&amp;value=---%0Auid%3A%20VisualCard.CardTools.GetCardParsers(System.IO.StreamReader)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/CardTools.cs/#L72">View Source</a>
</span>
<a id="VisualCard_CardTools_GetCardParsers_" data-uid="VisualCard.CardTools.GetCardParsers*"></a>
<h4 id="VisualCard_CardTools_GetCardParsers_StreamReader_" data-uid="VisualCard.CardTools.GetCardParsers(StreamReader)">GetCardParsers(StreamReader)</h4>
<h4 id="VisualCard_CardTools_GetCardParsers_System_IO_StreamReader_" data-uid="VisualCard.CardTools.GetCardParsers(System.IO.StreamReader)">GetCardParsers(StreamReader)</h4>
<div class="markdown level1 summary"><p>Gets the list of parsers for single/multiple contacts from the stream</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;BaseVcardParser&gt; GetCardParsers(StreamReader stream)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
Expand All @@ -121,15 +126,15 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">StreamReader</span></td>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.streamreader">StreamReader</a></td>
<td><span class="parametername">stream</span></td>
<td><p>Stream containing the contacts</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
Expand All @@ -138,25 +143,30 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">List</span>&lt;<a class="xref" href="VisualCard.Parsers.BaseVcardParser.html">BaseVcardParser</a>&gt;</td>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="VisualCard.Parsers.BaseVcardParser.html">BaseVcardParser</a>&gt;</td>
<td><p>List of contact parsers for single or multiple contacts</p>
</td>
</tr>
</tbody>
</table>


<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_CardTools_GetCardParsers_System_String_.md&amp;value=---%0Auid%3A%20VisualCard.CardTools.GetCardParsers(System.String)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/CardTools.cs/#L59">View Source</a>
</span>
<a id="VisualCard_CardTools_GetCardParsers_" data-uid="VisualCard.CardTools.GetCardParsers*"></a>
<h4 id="VisualCard_CardTools_GetCardParsers_System_String_" data-uid="VisualCard.CardTools.GetCardParsers(System.String)">GetCardParsers(String)</h4>
<h4 id="VisualCard_CardTools_GetCardParsers_System_String_" data-uid="VisualCard.CardTools.GetCardParsers(System.String)">GetCardParsers(string)</h4>
<div class="markdown level1 summary"><p>Gets the list of parsers for single/multiple contacts from the path</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;BaseVcardParser&gt; GetCardParsers(string Path)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
Expand All @@ -166,15 +176,15 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="parametername">Path</span></td>
<td><p>Path to the contacts file</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
Expand All @@ -183,25 +193,30 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">List</span>&lt;<a class="xref" href="VisualCard.Parsers.BaseVcardParser.html">BaseVcardParser</a>&gt;</td>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="VisualCard.Parsers.BaseVcardParser.html">BaseVcardParser</a>&gt;</td>
<td><p>List of contact parsers for single or multiple contacts</p>
</td>
</tr>
</tbody>
</table>


<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_CardTools_GetCardParsersFromString_System_String_.md&amp;value=---%0Auid%3A%20VisualCard.CardTools.GetCardParsersFromString(System.String)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/CardTools.cs/#L46">View Source</a>
</span>
<a id="VisualCard_CardTools_GetCardParsersFromString_" data-uid="VisualCard.CardTools.GetCardParsersFromString*"></a>
<h4 id="VisualCard_CardTools_GetCardParsersFromString_System_String_" data-uid="VisualCard.CardTools.GetCardParsersFromString(System.String)">GetCardParsersFromString(String)</h4>
<h4 id="VisualCard_CardTools_GetCardParsersFromString_System_String_" data-uid="VisualCard.CardTools.GetCardParsersFromString(System.String)">GetCardParsersFromString(string)</h4>
<div class="markdown level1 summary"><p>Gets the list of parsers for single/multiple contacts from the string</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;BaseVcardParser&gt; GetCardParsersFromString(string cardText)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
Expand All @@ -211,14 +226,14 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
<td><span class="parametername">cardText</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
Expand All @@ -227,19 +242,26 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">List</span>&lt;<a class="xref" href="VisualCard.Parsers.BaseVcardParser.html">BaseVcardParser</a>&gt;</td>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="VisualCard.Parsers.BaseVcardParser.html">BaseVcardParser</a>&gt;</td>
<td><p>List of contact parsers for single or multiple contacts</p>
</td>
</tr>
</tbody>
</table>

</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_CardTools.md&amp;value=---%0Auid%3A%20VisualCard.CardTools%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/CardTools.cs/#L39" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
Expand All @@ -250,22 +272,22 @@ <h5>In This Article</h5>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>

<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>

<script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
Expand Down
Loading

0 comments on commit 6b2c406

Please sign in to comment.