/ 
JMAP-Tester-0.013
River stage one • 1 direct dependent • 1 total dependent
/ JMAP::Tester::Response::Sentence

NAME

JMAP::Tester::Response::Sentence - a single triple within a JMAP response

VERSION

version 0.013

OVERVIEW

These objects represent sentences in the JMAP response. That is, if your response is:

[
  [ "messages", { ... }, "a" ],      # 1
  [ "smellUpdates", { ... }, "b" ],  # 2
  [ "smells",       { ... }, "b" ],  # 3
]

...then #1, #2, and #3 are each a single sentence.

The first item in the triple is accessed with the name method. The second is accessed with the arguments method. The third, with the client_id method.

METHODS

as_struct

as_stripped_struct

as_struct returns the underlying JSON data of the sentence, which may include objects used to convey type information for booleans, strings, and numbers.

For raw data, use as_stripped_struct.

These return a three-element arrayref.

as_pair

as_stripped_pair

as_pair returns the same thing as as_struct, but without the client_id. That means it returns a two-element arrayref.

as_stripped_pair returns the same minus JSON type information.

as_set

This method returns a JMAP::Tester::Response::Sentence::Set object for the current sentence. That's a specialized Sentence for setFoos-style JMAP method responses.

assert_named

$sentence->assert_named("theName")

This method aborts unless the sentence's name is the given name. Otherwise, it returns the sentence.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by FastMail, Ltd.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.