| Joe Gregorio | 37802c3 | 2013-08-06 12:24:05 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="v1dev_v1dev.html">Wax API</a> . <a href="v1dev_v1dev.sessions.html">sessions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(body)</a></code></p> |
| 79 | <p class="firstline">Creates a new session. New sessions are initialized with two pre-defined items. Just like wax.sessions.newsession, but matches other implementations of Wax in Endpoints.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#newSession">newSession(body, sessionName=None)</a></code></p> |
| 82 | <p class="firstline">Creates a new session. New sessions are initialized with two pre-defined items.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#removeSession">removeSession(body, sessionId=None)</a></code></p> |
| 85 | <p class="firstline">Removes a session. Clients that create sessions with long or infinite durations should call this method to clean up after themselves.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="create">create(body)</code> |
| 89 | <pre>Creates a new session. New sessions are initialized with two pre-defined items. Just like wax.sessions.newsession, but matches other implementations of Wax in Endpoints. |
| 90 | |
| 91 | Args: |
| 92 | body: object, The request body. (required) |
| 93 | The object takes the form of: |
| 94 | |
| 95 | { |
| 96 | "sessionName": "A String", # Usually a short, human-readable name that describes a session. This name will appear as part of the session ID, which is generated by the API when the session is created. |
| 97 | "durationInMillis": "A String", # Session duration in milliseconds. |
| 98 | } |
| 99 | |
| 100 | |
| 101 | Returns: |
| 102 | An object of the form: |
| 103 | |
| 104 | { |
| 105 | "newSessionId": "A String", # The session ID. |
| 106 | "kind": "wax#waxNewSession", # The kind of object this is. |
| 107 | }</pre> |
| 108 | </div> |
| 109 | |
| 110 | <div class="method"> |
| 111 | <code class="details" id="newSession">newSession(body, sessionName=None)</code> |
| 112 | <pre>Creates a new session. New sessions are initialized with two pre-defined items. |
| 113 | |
| 114 | Args: |
| 115 | body: object, The request body. (required) |
| 116 | The object takes the form of: |
| 117 | |
| 118 | { |
| 119 | "newSessionParams": { # Parameters used when requesting a new session. |
| 120 | "kind": "wax#waxNewSessionParams", # The kind of object this is. |
| 121 | "durationInMillis": "A String", # Session duration in milliseconds. |
| 122 | }, |
| 123 | "sessionName": "A String", # Usually a short, human-readable name that describes a session. This name will appear as part of the session ID, which is generated by the API when the session is created. |
| 124 | } |
| 125 | |
| 126 | sessionName: string, Human-readable name that describes a session. This name will be part of the session ID. |
| 127 | |
| 128 | Returns: |
| 129 | An object of the form: |
| 130 | |
| 131 | { |
| 132 | "newSessionId": "A String", # The session ID. |
| 133 | "kind": "wax#waxNewSession", # The kind of object this is. |
| 134 | }</pre> |
| 135 | </div> |
| 136 | |
| 137 | <div class="method"> |
| 138 | <code class="details" id="removeSession">removeSession(body, sessionId=None)</code> |
| 139 | <pre>Removes a session. Clients that create sessions with long or infinite durations should call this method to clean up after themselves. |
| 140 | |
| 141 | Args: |
| 142 | body: object, The request body. (required) |
| 143 | The object takes the form of: |
| 144 | |
| 145 | { |
| 146 | "sessionId": "A String", # The ID corresponding to the session to be removed. |
| 147 | } |
| 148 | |
| 149 | sessionId: string, The session ID. |
| 150 | |
| 151 | Returns: |
| 152 | An object of the form: |
| 153 | |
| 154 | { |
| 155 | "kind": "wax#waxRemoveSession", # The kind of object this is. |
| 156 | "removedSessionId": "A String", # The ID corresponding to the session that was removed. |
| 157 | }</pre> |
| 158 | </div> |
| 159 | |
| 160 | </body></html> |