[doc] Added documentation for sample stream v2

linvi · Oct 11, 2020 · ad09020 · ad09020
1 parent 2004dd6
commit ad09020
Show file tree

Hide file tree

Showing 71 changed files with 918 additions and 374 deletions.
diff --git a/docs/dist/_sources/index.rst.txt b/docs/dist/_sources/index.rst.txt
@@ -76,16 +76,23 @@ The goal of this library is to make life of developers as easy as possible.
 .. toctree::
  :maxdepth: 1
  :hidden:
- :caption: Streams
+ :caption: Streams V1.1
 
- streams/streams-introduction
- streams/tweet-stream
- streams/sample-stream
- streams/filtered-stream
- streams/filtered-stream-filters
+ streams-v1.1/streams-introduction
+ streams-v1.1/tweet-stream
+ streams-v1.1/sample-stream
+ streams-v1.1/filtered-stream
+ streams-v1.1/filtered-stream-filters
 
- streams/labs-sample-stream
- streams/labs-filtered-stream
+ streams-v1.1/labs-sample-stream
+ streams-v1.1/labs-filtered-stream
+
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+ :caption: Streams V2
+
+ streams-v2/sample-stream
 
 .. toctree::
  :maxdepth: 1

diff --git a/...es/streams/filtered-stream-filters.md.txt → ...reams-v1.1/filtered-stream-filters.md.txt b/...es/streams/filtered-stream-filters.md.txt → ...reams-v1.1/filtered-stream-filters.md.txt
diff --git a/...t/_sources/streams/filtered-stream.md.txt → ...urces/streams-v1.1/filtered-stream.md.txt b/...t/_sources/streams/filtered-stream.md.txt → ...urces/streams-v1.1/filtered-stream.md.txt
diff --git a/...urces/streams/labs-filtered-stream.md.txt → .../streams-v1.1/labs-filtered-stream.md.txt b/...urces/streams/labs-filtered-stream.md.txt → .../streams-v1.1/labs-filtered-stream.md.txt
diff --git a/...sources/streams/labs-sample-stream.md.txt → ...es/streams-v1.1/labs-sample-stream.md.txt b/...sources/streams/labs-sample-stream.md.txt → ...es/streams-v1.1/labs-sample-stream.md.txt
diff --git a/...ist/_sources/streams/sample-stream.md.txt → ...sources/streams-v1.1/sample-stream.md.txt b/...ist/_sources/streams/sample-stream.md.txt → ...sources/streams-v1.1/sample-stream.md.txt
diff --git a/...urces/streams/streams-introduction.md.txt → .../streams-v1.1/streams-introduction.md.txt b/...urces/streams/streams-introduction.md.txt → .../streams-v1.1/streams-introduction.md.txt
diff --git a/...dist/_sources/streams/tweet-stream.md.txt → ..._sources/streams-v1.1/tweet-stream.md.txt b/...dist/_sources/streams/tweet-stream.md.txt → ..._sources/streams-v1.1/tweet-stream.md.txt
diff --git a/docs/dist/_sources/streams-v2/sample-stream.md.txt b/docs/dist/_sources/streams-v2/sample-stream.md.txt
@@ -0,0 +1,13 @@
+# Sample Stream V2
+
+> The sampled stream endpoint delivers a roughly 1% random sample of publicly available Tweets in real-time. With it, you can identify and track trends, monitor general sentiment, monitor global events, and much more.
+
+``` c#
+var sampleStreamV2 = appClient.StreamsV2.CreateSampleStream();
+sampleStreamV2.TweetReceived += (sender, args) =>
+{
+ System.Console.WriteLine(args.Tweet.Text);
+};
+
+await sampleStreamV2.StartAsync();
+```
diff --git a/docs/dist/account-activity/account-activity-events.html b/docs/dist/account-activity/account-activity-events.html
@@ -38,7 +38,7 @@
 
  <link rel="index" title="Index" href="../genindex.html" />
  <link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="Streams Introduction" href="../streams/streams-introduction.html" />
+ <link rel="next" title="Streams Introduction" href="../streams-v1.1/streams-introduction.html" />
  <link rel="prev" title="Account Activity - Subscriptions" href="account-activity-subscriptions.html" /> 
 </head>
 
@@ -136,15 +136,19 @@
 </ul>
 </li>
 </ul>
-<p class="caption"><span class="caption-text">Streams</span></p>
+<p class="caption"><span class="caption-text">Streams V1.1</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../streams/streams-introduction.html">Streams Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/tweet-stream.html">Tweet Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/sample-stream.html">Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream.html">Filtered Streams</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-sample-stream.html">Labs Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/streams-introduction.html">Streams Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/tweet-stream.html">Tweet Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/sample-stream.html">Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream.html">Filtered Streams</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-sample-stream.html">Labs Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Streams V2</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v2/sample-stream.html">Sample Stream V2</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Twitter Client</span></p>
 <ul>
@@ -620,7 +624,7 @@ <h2>Events<a class="headerlink" href="#events" title="Permalink to this headline
 
  <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
- <a href="../streams/streams-introduction.html" class="btn btn-neutral float-right" title="Streams Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../streams-v1.1/streams-introduction.html" class="btn btn-neutral float-right" title="Streams Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
  <a href="account-activity-subscriptions.html" class="btn btn-neutral float-left" title="Account Activity - Subscriptions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

diff --git a/docs/dist/account-activity/account-activity-subscriptions.html b/docs/dist/account-activity/account-activity-subscriptions.html
@@ -135,15 +135,19 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="account-activity-events.html">Account Activity - Stream/Events</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Streams</span></p>
+<p class="caption"><span class="caption-text">Streams V1.1</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../streams/streams-introduction.html">Streams Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/tweet-stream.html">Tweet Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/sample-stream.html">Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream.html">Filtered Streams</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-sample-stream.html">Labs Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/streams-introduction.html">Streams Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/tweet-stream.html">Tweet Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/sample-stream.html">Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream.html">Filtered Streams</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-sample-stream.html">Labs Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Streams V2</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v2/sample-stream.html">Sample Stream V2</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Twitter Client</span></p>
 <ul>

diff --git a/docs/dist/account-activity/account-activity-with-aspnet.html b/docs/dist/account-activity/account-activity-with-aspnet.html
@@ -134,15 +134,19 @@
 <li class="toctree-l1"><a class="reference internal" href="account-activity-subscriptions.html">Account Activity - Subscriptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="account-activity-events.html">Account Activity - Stream/Events</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Streams</span></p>
+<p class="caption"><span class="caption-text">Streams V1.1</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../streams/streams-introduction.html">Streams Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/tweet-stream.html">Tweet Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/sample-stream.html">Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream.html">Filtered Streams</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-sample-stream.html">Labs Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/streams-introduction.html">Streams Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/tweet-stream.html">Tweet Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/sample-stream.html">Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream.html">Filtered Streams</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-sample-stream.html">Labs Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Streams V2</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v2/sample-stream.html">Sample Stream V2</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Twitter Client</span></p>
 <ul>

diff --git a/docs/dist/account-activity/account-activity-with-http-server.html b/docs/dist/account-activity/account-activity-with-http-server.html
@@ -131,15 +131,19 @@
 <li class="toctree-l1"><a class="reference internal" href="account-activity-subscriptions.html">Account Activity - Subscriptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="account-activity-events.html">Account Activity - Stream/Events</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Streams</span></p>
+<p class="caption"><span class="caption-text">Streams V1.1</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../streams/streams-introduction.html">Streams Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/tweet-stream.html">Tweet Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/sample-stream.html">Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream.html">Filtered Streams</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-sample-stream.html">Labs Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/streams-introduction.html">Streams Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/tweet-stream.html">Tweet Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/sample-stream.html">Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream.html">Filtered Streams</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-sample-stream.html">Labs Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Streams V2</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v2/sample-stream.html">Sample Stream V2</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Twitter Client</span></p>
 <ul>

diff --git a/docs/dist/account-activity/account-activity.html b/docs/dist/account-activity/account-activity.html
@@ -142,15 +142,19 @@
 <li class="toctree-l1"><a class="reference internal" href="account-activity-subscriptions.html">Account Activity - Subscriptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="account-activity-events.html">Account Activity - Stream/Events</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Streams</span></p>
+<p class="caption"><span class="caption-text">Streams V1.1</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../streams/streams-introduction.html">Streams Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/tweet-stream.html">Tweet Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/sample-stream.html">Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream.html">Filtered Streams</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-sample-stream.html">Labs Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/streams-introduction.html">Streams Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/tweet-stream.html">Tweet Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/sample-stream.html">Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream.html">Filtered Streams</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-sample-stream.html">Labs Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Streams V2</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v2/sample-stream.html">Sample Stream V2</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Twitter Client</span></p>
 <ul>

diff --git a/docs/dist/authentication/authentication-pin-code.html b/docs/dist/authentication/authentication-pin-code.html
@@ -135,15 +135,19 @@
 <li class="toctree-l1"><a class="reference internal" href="../account-activity/account-activity-subscriptions.html">Account Activity - Subscriptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../account-activity/account-activity-events.html">Account Activity - Stream/Events</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Streams</span></p>
+<p class="caption"><span class="caption-text">Streams V1.1</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../streams/streams-introduction.html">Streams Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/tweet-stream.html">Tweet Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/sample-stream.html">Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream.html">Filtered Streams</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-sample-stream.html">Labs Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/streams-introduction.html">Streams Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/tweet-stream.html">Tweet Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/sample-stream.html">Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream.html">Filtered Streams</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-sample-stream.html">Labs Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Streams V2</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v2/sample-stream.html">Sample Stream V2</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Twitter Client</span></p>
 <ul>

diff --git a/docs/dist/authentication/authentication-url-redirect.html b/docs/dist/authentication/authentication-url-redirect.html
@@ -136,15 +136,19 @@
 <li class="toctree-l1"><a class="reference internal" href="../account-activity/account-activity-subscriptions.html">Account Activity - Subscriptions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../account-activity/account-activity-events.html">Account Activity - Stream/Events</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Streams</span></p>
+<p class="caption"><span class="caption-text">Streams V1.1</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../streams/streams-introduction.html">Streams Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/tweet-stream.html">Tweet Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/sample-stream.html">Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream.html">Filtered Streams</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-sample-stream.html">Labs Sample Stream</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../streams/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/streams-introduction.html">Streams Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/tweet-stream.html">Tweet Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/sample-stream.html">Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream.html">Filtered Streams</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/filtered-stream-filters.html">Filtered Stream - Filters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-sample-stream.html">Labs Sample Stream</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v1.1/labs-filtered-stream.html">Labs Filtered Stream</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Streams V2</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../streams-v2/sample-stream.html">Sample Stream V2</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Twitter Client</span></p>
 <ul>