Skip to content

Commit 3ed8569

Browse files
committed
Updated message size spec as per review comments
1 parent 7fdfeb3 commit 3ed8569

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

textile/features.textile

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1453,11 +1453,11 @@ h4. Message
14531453
** @(TM6a)@ The size is the sum of the sizes of the @name@, @data@, @clientId@, and @extras@ properties
14541454
** @(TM6b)@ The size of an @Object@ or @Array@ @data@ property is its string length after being JSON-stringified
14551455
** @(TM6c)@ The size of a @binary@ @data@ property is its size in bytes (of the actual binary, not the base64 representation, regardless of whether the binary protocol is in use).
1456-
** @(TM6f)@ The size of a @string@ @data@ property is its UTF-8 encoded length in bytes (because of Non-ASCII characters)
1457-
** @(TM6g)@ The size of a @string@ @name@ property is its length
1458-
** @(TM6h)@ The size of a @string@ @clientId@ property is its length
1459-
** @(TM6d)@ The size of the @extras@ property is the string length of its JSON representation
1460-
** @(TM6e)@ The size of a @null@ or omitted property is zero
1456+
** @(TM6f)@ The size of a @string@ @data@ property is its UTF-8 encoded length in bytes (because of Non-ASCII characters, i.e. 你 is 3 bytes, 😊 is 4 bytes).
1457+
** @(TM6g)@ The size of a @string@ @name@ property is its UTF-8 encoded length in bytes.
1458+
** @(TM6h)@ The size of a @string@ @clientId@ property is its UTF-8 encoded length in bytes.
1459+
** @(TM6d)@ The size of the @extras@ property is the UTF-8 encoded length of its JSON string representation.
1460+
** @(TM6e)@ The size of a @null@, omitted or missing property is zero
14611461
* @(TM7)@ The SDK may expose a series of functions (static factory methods on a Message or otherwise, wherever is language idiomatic; for some languages this might just be types that can be used for type assertions, etc), that take a deserialized @JsonObject@, one of the aggregated summaries for a particular annotation type (that is, a value from the @TM2q@ @summary@ @Dict@), and outputs a strongly-typed summary entry, for ease of use by the end user (particularly in languages where manipulating plain objects is difficult).
14621462
** @(TM7a)@ The SDK must not try to do this conversion automatically (either by parsing the annotation type or dynamically detecting the structure). This is so that, when the server adds new annotation types that the SDK does not yet know about, when we later add support for those new types to the SDK, that does not result in a a breaking API change for the SDK.
14631463
** @(TM7b)@ If the SDK chooses to do this, it should support at least the following set of constructors (or other language-idiomatic mechanism that achieves a similar result):
@@ -1630,7 +1630,7 @@ h4. ObjectData
16301630
** @(OD3b)@ If set, the size of a @boolean@ property is 1
16311631
** @(OD3c)@ If set, the size of a @bytes@ property is its size in bytes (of the actual binary, not the base64 representation, regardless of whether the binary protocol is in use)
16321632
** @(OD3d)@ If set, the size of a @number@ property is 8
1633-
** @(OD3e)@ If set, the size of a @string@ property is its UTF-8 encoded length in bytes (because of Non-ASCII characters)
1633+
** @(OD3e)@ If set, the size of a @string@ property is its UTF-8 encoded length in bytes (because of Non-ASCII characters, i.e. 你 is 3 bytes, 😊 is 4 bytes)
16341634
** @(OD3f)@ The size of a @null@ or omitted property is zero
16351635

16361636
h4. Annotation

0 commit comments

Comments
 (0)