From e25bd18816868fe4b72e0062b6082611a4385c59 Mon Sep 17 00:00:00 2001
From: eutarass
Date: Thu, 13 Aug 2009 20:23:14 +0000
Subject: Bug 284963: Add a third parameter to the streams service “created”
 event

---
 docs/TCF Service - Streams.html | 31 ++++++++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

(limited to 'docs')

diff --git a/docs/TCF Service - Streams.html b/docs/TCF Service - Streams.html
index 6c7879b8e..3d166f869 100644
--- a/docs/TCF Service - Streams.html	
+++ b/docs/TCF Service - Streams.html	
@@ -42,6 +42,10 @@
         <td>0.2
         <td>2009-05-18
         <td>Added connect command
+    <tr>
+        <td>0.3
+        <td>2009-08-13
+        <td>Added "context ID" argument in "created" event
 </table>
 
 <h2><a name='Overview'>Overview</a></h2>
@@ -213,9 +217,27 @@ R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
 Clients can change their subscription with <b>subscribe</b> and <b>unsubscribe</b> commands.</p>
  
 <pre><b><font face="Courier New" size=2 color=#333399>
-E &bull; Streams &bull; created &bull; <i>&lt;string: stream type&gt;</i> &bull; <i>&lt;string: stream ID&gt;</i> &bull;
+E &bull; Streams &bull; created &bull; <i>&lt;string: stream type&gt;</i> &bull; <i>&lt;string: stream ID&gt;</i> &bull; <i>&lt;string: context ID&gt;</i> &bull;
+</font></b></pre>
+<p>
+Sent when a new stream is created.
+"stream type" - source type of the stream.
+"stream ID" - ID of the stream.
+"context ID" - a context ID that is associated with the stream, or null.
+</p>
+<p>
+Exact meaning of the context ID depends on stream type.
+Stream types and context IDs are defined by services that use Streams service to transmit data.
+</p>
+
+<pre><b><font face="Courier New" size=2 color=#333399>
 E &bull; Streams &bull; disposed &bull; <i>&lt;string: stream type&gt;</i> &bull; <i>&lt;string: stream ID&gt;</i> &bull;
 </font></b></pre>
+<p>
+Sent when a stream is disposed. 
+"stream type" - source type of the stream.
+"stream ID" - ID of the stream.
+</p>
 
 <h2><a name='API'>API</a></h2>
  
@@ -238,11 +260,14 @@ E &bull; Streams &bull; disposed &bull; <i>&lt;string: stream type&gt;</i> &bull
     <font color=#7F0055>interface</font> StreamsListener {
         
         <font color=#3F5FBF>/**
-         * Called when a new stream is created. 
+         * Called when a new stream is created.
          * <font color=#7F9FBF>@param</font> stream_type - source type of the stream.
          * <font color=#7F9FBF>@param</font> stream_id - ID of the stream.
+         * <font color=#7F9FBF>@param</font> context_id - a context ID that is associated with the stream, or null.
+         * Exact meaning of the context ID depends on stream type.
+         * Stream types and context IDs are defined by services that use Streams service to transmit data.
          */</font>
-        <font color=#7F0055>void</font> created(String stream_type, String stream_id);
+        <font color=#7F0055>void</font> created(String stream_type, String stream_id, String context_id);
         
         <font color=#3F5FBF>/**
          * Called when a stream is disposed. 
-- 
cgit v1.2.3