wsc_sdk 1.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.circleci/config.yml +146 -0
- data/.circleci/docker/build/Dockerfile +3 -0
- data/.circleci/helpers/add_preamble.rb +29 -0
- data/.circleci/helpers/build_docs.sh +5 -0
- data/.circleci/helpers/build_gem.sh +5 -0
- data/.circleci/helpers/debundle-context.sh +14 -0
- data/.circleci/helpers/finalize_release.sh +24 -0
- data/.circleci/helpers/publish_docs.sh +10 -0
- data/.circleci/helpers/release_gem.sh +8 -0
- data/.circleci/helpers/setup.sh +11 -0
- data/.circleci/helpers/setup_aws.sh +13 -0
- data/.circleci/helpers/setup_gem.sh +2 -0
- data/.circleci/helpers/setup_git.sh +27 -0
- data/.circleci/helpers/setup_rubygems.sh +15 -0
- data/.circleci/helpers/test_integration.sh +12 -0
- data/.circleci/helpers/test_unit.sh +6 -0
- data/.circleci/jobs/publish-production.sh +17 -0
- data/.circleci/jobs/publish-staging.sh +17 -0
- data/.circleci/jobs/release-production.sh +21 -0
- data/.circleci/jobs/test-integration.sh +9 -0
- data/.circleci/jobs/test-unit.sh +9 -0
- data/.circleci/tag_repo.rb +46 -0
- data/.gitignore +28 -0
- data/.rspec +2 -0
- data/.yard/config +2 -0
- data/.yard/template/default/fulldoc/html/css/custom.css +151 -0
- data/.yard/template/default/layout/html/footer.erb +0 -0
- data/.yard/template/default/layout/html/headers.erb +10 -0
- data/.yard/template/default/layout/html/layout.erb +45 -0
- data/.yard/template/default/layout/html/setup.rb +24 -0
- data/.yardopts +1 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +99 -0
- data/LICENSE.txt +28 -0
- data/README.md +397 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/Hash.html +291 -0
- data/doc/WscSdk.html +570 -0
- data/doc/WscSdk/ApiResponse.html +242 -0
- data/doc/WscSdk/Attributes.html +128 -0
- data/doc/WscSdk/Attributes/Mode.html +191 -0
- data/doc/WscSdk/Attributes/Type.html +389 -0
- data/doc/WscSdk/Client.html +2677 -0
- data/doc/WscSdk/Configuration.html +595 -0
- data/doc/WscSdk/Endpoint.html +2974 -0
- data/doc/WscSdk/Endpoints.html +141 -0
- data/doc/WscSdk/Endpoints/CustomStreamTargets.html +383 -0
- data/doc/WscSdk/Endpoints/LiveStreams.html +197 -0
- data/doc/WscSdk/Endpoints/OutputStreamTargets.html +180 -0
- data/doc/WscSdk/Endpoints/Outputs.html +180 -0
- data/doc/WscSdk/Endpoints/StreamTargets.html +446 -0
- data/doc/WscSdk/Endpoints/Transcoders.html +197 -0
- data/doc/WscSdk/Endpoints/UllStreamTargets.html +383 -0
- data/doc/WscSdk/Endpoints/WowzaStreamTargets.html +383 -0
- data/doc/WscSdk/Enum.html +225 -0
- data/doc/WscSdk/Enums.html +321 -0
- data/doc/WscSdk/Enums/BillingMode.html +188 -0
- data/doc/WscSdk/Enums/BroadcastLocation.html +396 -0
- data/doc/WscSdk/Enums/BufferSize.html +301 -0
- data/doc/WscSdk/Enums/ClosedCaptionType.html +221 -0
- data/doc/WscSdk/Enums/CustomProvider.html +252 -0
- data/doc/WscSdk/Enums/DeliveryMethod.html +188 -0
- data/doc/WscSdk/Enums/DeliveryType.html +188 -0
- data/doc/WscSdk/Enums/Encoder.html +460 -0
- data/doc/WscSdk/Enums/Errors.html +555 -0
- data/doc/WscSdk/Enums/IdleTimeout.html +398 -0
- data/doc/WscSdk/Enums/ImagePosition.html +220 -0
- data/doc/WscSdk/Enums/ModelMode.html +175 -0
- data/doc/WscSdk/Enums/ModelType.html +373 -0
- data/doc/WscSdk/Enums/PlayerType.html +188 -0
- data/doc/WscSdk/Enums/Protocol.html +204 -0
- data/doc/WscSdk/Enums/TargetDeliveryProtocol.html +188 -0
- data/doc/WscSdk/Enums/TranscoderType.html +188 -0
- data/doc/WscSdk/Enums/UserRegion.html +383 -0
- data/doc/WscSdk/Enums/WowzaProvider.html +188 -0
- data/doc/WscSdk/Errors.html +683 -0
- data/doc/WscSdk/Loggable.html +346 -0
- data/doc/WscSdk/Model.html +3316 -0
- data/doc/WscSdk/ModelList.html +442 -0
- data/doc/WscSdk/ModelTemplate.html +267 -0
- data/doc/WscSdk/Models.html +141 -0
- data/doc/WscSdk/Models/CustomStreamTarget.html +192 -0
- data/doc/WscSdk/Models/Error.html +351 -0
- data/doc/WscSdk/Models/LiveStream.html +601 -0
- data/doc/WscSdk/Models/LiveStreamConnectionCode.html +192 -0
- data/doc/WscSdk/Models/LiveStreamState.html +200 -0
- data/doc/WscSdk/Models/LiveStreamStats.html +200 -0
- data/doc/WscSdk/Models/LiveStreamThumbnailUrl.html +200 -0
- data/doc/WscSdk/Models/Output.html +294 -0
- data/doc/WscSdk/Models/OutputStreamTarget.html +274 -0
- data/doc/WscSdk/Models/StreamTarget.html +273 -0
- data/doc/WscSdk/Models/Transcoder.html +793 -0
- data/doc/WscSdk/Models/TranscoderBooleanStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderConnectionCode.html +192 -0
- data/doc/WscSdk/Models/TranscoderFloatStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderIntegerStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderState.html +196 -0
- data/doc/WscSdk/Models/TranscoderStats.html +196 -0
- data/doc/WscSdk/Models/TranscoderStreamTargetState.html +192 -0
- data/doc/WscSdk/Models/TranscoderStringStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderThumbnailUrl.html +196 -0
- data/doc/WscSdk/Models/UllStreamTarget.html +360 -0
- data/doc/WscSdk/Models/WowzaStreamTarget.html +380 -0
- data/doc/WscSdk/Pagination.html +1277 -0
- data/doc/WscSdk/Schema.html +861 -0
- data/doc/WscSdk/SchemaAttribute.html +2400 -0
- data/doc/WscSdk/Templates.html +141 -0
- data/doc/WscSdk/Templates/CustomStreamTarget.html +1045 -0
- data/doc/WscSdk/Templates/LiveStream.html +1432 -0
- data/doc/WscSdk/Templates/Output.html +829 -0
- data/doc/WscSdk/Templates/Transcoder.html +699 -0
- data/doc/WscSdk/Templates/UllStreamTarget.html +411 -0
- data/doc/WscSdk/Templates/WowzaStreamTarget.html +447 -0
- data/doc/WscSdk/TranscoderSharedMethods.html +1113 -0
- data/doc/_index.html +705 -0
- data/doc/class_list.html +51 -0
- data/doc/css/bootstrap.css +5 -0
- data/doc/css/common.css +1 -0
- data/doc/css/custom.css +151 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +570 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/images/wsc-ruby-1800x400.png +0 -0
- data/doc/index.html +570 -0
- data/doc/js/app.js +292 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1731 -0
- data/doc/top-level-namespace.html +182 -0
- data/examples/client.rb +40 -0
- data/examples/helpers.rb +100 -0
- data/examples/live_streams/create.rb +39 -0
- data/examples/live_streams/delete.rb +32 -0
- data/examples/live_streams/find.rb +22 -0
- data/examples/live_streams/flood.rb +126 -0
- data/examples/live_streams/list.rb +24 -0
- data/examples/live_streams/regenerate_connection_code.rb +29 -0
- data/examples/live_streams/reset.rb +32 -0
- data/examples/live_streams/reset_and_wait.rb +51 -0
- data/examples/live_streams/start.rb +33 -0
- data/examples/live_streams/start_and_wait.rb +51 -0
- data/examples/live_streams/state.rb +33 -0
- data/examples/live_streams/stats.rb +43 -0
- data/examples/live_streams/stop.rb +33 -0
- data/examples/live_streams/stop_and_wait.rb +51 -0
- data/examples/live_streams/thumbnail_url.rb +46 -0
- data/examples/live_streams/update.rb +43 -0
- data/examples/live_streams/workflow.rb +165 -0
- data/examples/output_stream_targets/create.rb +56 -0
- data/examples/output_stream_targets/delete.rb +45 -0
- data/examples/output_stream_targets/find.rb +37 -0
- data/examples/output_stream_targets/list.rb +36 -0
- data/examples/output_stream_targets/update.rb +56 -0
- data/examples/outputs/create.rb +49 -0
- data/examples/outputs/delete.rb +39 -0
- data/examples/outputs/find.rb +31 -0
- data/examples/outputs/list.rb +29 -0
- data/examples/outputs/update.rb +50 -0
- data/examples/stream_targets/custom/create.rb +42 -0
- data/examples/stream_targets/custom/delete.rb +31 -0
- data/examples/stream_targets/custom/find.rb +23 -0
- data/examples/stream_targets/custom/list.rb +24 -0
- data/examples/stream_targets/custom/update.rb +43 -0
- data/examples/stream_targets/list.rb +24 -0
- data/examples/stream_targets/ull/create.rb +41 -0
- data/examples/stream_targets/ull/delete.rb +31 -0
- data/examples/stream_targets/ull/find.rb +23 -0
- data/examples/stream_targets/ull/list.rb +24 -0
- data/examples/stream_targets/ull/update.rb +43 -0
- data/examples/stream_targets/wowza/create.rb +42 -0
- data/examples/stream_targets/wowza/delete.rb +31 -0
- data/examples/stream_targets/wowza/find.rb +23 -0
- data/examples/stream_targets/wowza/list.rb +23 -0
- data/examples/stream_targets/wowza/update.rb +43 -0
- data/examples/transcoders/create.rb +39 -0
- data/examples/transcoders/delete.rb +31 -0
- data/examples/transcoders/find.rb +23 -0
- data/examples/transcoders/list.rb +24 -0
- data/examples/transcoders/reset.rb +32 -0
- data/examples/transcoders/reset_and_wait.rb +48 -0
- data/examples/transcoders/start.rb +33 -0
- data/examples/transcoders/start_and_wait.rb +50 -0
- data/examples/transcoders/state.rb +33 -0
- data/examples/transcoders/stats.rb +43 -0
- data/examples/transcoders/stop.rb +33 -0
- data/examples/transcoders/stop_and_wait.rb +50 -0
- data/examples/transcoders/thumbnail_url.rb +46 -0
- data/examples/transcoders/update.rb +43 -0
- data/images/wsc-ruby-1800x400.png +0 -0
- data/lib/wsc_sdk.rb +81 -0
- data/lib/wsc_sdk/client.rb +417 -0
- data/lib/wsc_sdk/configuration.rb +21 -0
- data/lib/wsc_sdk/constants.rb +29 -0
- data/lib/wsc_sdk/endpoint.rb +492 -0
- data/lib/wsc_sdk/endpoints/custom_stream_targets.rb +44 -0
- data/lib/wsc_sdk/endpoints/live_streams.rb +34 -0
- data/lib/wsc_sdk/endpoints/output_stream_targets.rb +17 -0
- data/lib/wsc_sdk/endpoints/outputs.rb +17 -0
- data/lib/wsc_sdk/endpoints/stream_targets.rb +45 -0
- data/lib/wsc_sdk/endpoints/transcoders.rb +38 -0
- data/lib/wsc_sdk/endpoints/ull_stream_targets.rb +44 -0
- data/lib/wsc_sdk/endpoints/wowza_stream_targets.rb +44 -0
- data/lib/wsc_sdk/enums.rb +31 -0
- data/lib/wsc_sdk/enums/billing_mode.rb +20 -0
- data/lib/wsc_sdk/enums/broadcast_location.rb +58 -0
- data/lib/wsc_sdk/enums/buffer_size.rb +41 -0
- data/lib/wsc_sdk/enums/closed_caption_type.rb +26 -0
- data/lib/wsc_sdk/enums/custom_provider.rb +32 -0
- data/lib/wsc_sdk/enums/delivery_method.rb +20 -0
- data/lib/wsc_sdk/enums/delivery_type.rb +20 -0
- data/lib/wsc_sdk/enums/encoder.rb +71 -0
- data/lib/wsc_sdk/enums/idle_timeout.rb +50 -0
- data/lib/wsc_sdk/enums/image_position.rb +26 -0
- data/lib/wsc_sdk/enums/player_type.rb +20 -0
- data/lib/wsc_sdk/enums/protocol.rb +23 -0
- data/lib/wsc_sdk/enums/target_delivery_protocol.rb +20 -0
- data/lib/wsc_sdk/enums/transcoder_type.rb +20 -0
- data/lib/wsc_sdk/enums/wowza_provider.rb +20 -0
- data/lib/wsc_sdk/errors.rb +115 -0
- data/lib/wsc_sdk/model.rb +515 -0
- data/lib/wsc_sdk/model_list.rb +42 -0
- data/lib/wsc_sdk/model_template.rb +27 -0
- data/lib/wsc_sdk/models/custom_stream_target.rb +34 -0
- data/lib/wsc_sdk/models/error.rb +53 -0
- data/lib/wsc_sdk/models/live_stream.rb +130 -0
- data/lib/wsc_sdk/models/live_stream_connection_code.rb +31 -0
- data/lib/wsc_sdk/models/live_stream_state.rb +20 -0
- data/lib/wsc_sdk/models/live_stream_stats.rb +20 -0
- data/lib/wsc_sdk/models/live_stream_thumbnail_url.rb +20 -0
- data/lib/wsc_sdk/models/output.rb +61 -0
- data/lib/wsc_sdk/models/output_stream_target.rb +37 -0
- data/lib/wsc_sdk/models/stream_target.rb +29 -0
- data/lib/wsc_sdk/models/transcoder.rb +135 -0
- data/lib/wsc_sdk/models/transcoder_boolean_stat.rb +41 -0
- data/lib/wsc_sdk/models/transcoder_connection_code.rb +29 -0
- data/lib/wsc_sdk/models/transcoder_float_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_integer_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_state.rb +31 -0
- data/lib/wsc_sdk/models/transcoder_stats.rb +51 -0
- data/lib/wsc_sdk/models/transcoder_stream_target_state.rb +29 -0
- data/lib/wsc_sdk/models/transcoder_string_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_thumbnail_url.rb +29 -0
- data/lib/wsc_sdk/models/ull_stream_target.rb +54 -0
- data/lib/wsc_sdk/models/wowza_stream_target.rb +60 -0
- data/lib/wsc_sdk/modules/api_response.rb +24 -0
- data/lib/wsc_sdk/modules/loggable.rb +44 -0
- data/lib/wsc_sdk/modules/transcoder_shared_methods.rb +221 -0
- data/lib/wsc_sdk/pagination.rb +89 -0
- data/lib/wsc_sdk/schema.rb +140 -0
- data/lib/wsc_sdk/schema_attribute.rb +349 -0
- data/lib/wsc_sdk/templates/custom_stream_target.rb +154 -0
- data/lib/wsc_sdk/templates/live_stream.rb +234 -0
- data/lib/wsc_sdk/templates/output.rb +133 -0
- data/lib/wsc_sdk/templates/transcoder.rb +97 -0
- data/lib/wsc_sdk/templates/ull_stream_target.rb +49 -0
- data/lib/wsc_sdk/templates/wowza_stream_target.rb +57 -0
- data/lib/wsc_sdk/version.rb +7 -0
- data/wsc_sdk.gemspec +48 -0
- metadata +460 -0
data/doc/Hash.html
ADDED
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Hash
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.18
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "Hash";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (H)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Hash</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Hash
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Hash</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/wsc_sdk/modifiers/hash.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Hash class modifications</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div><div id="subclasses">
|
|
114
|
+
<h2>Direct Known Subclasses</h2>
|
|
115
|
+
<p class="children"><span class='object_link'><a href="WscSdk/ModelList.html" title="WscSdk::ModelList (class)">WscSdk::ModelList</a></span>, <span class='object_link'><a href="WscSdk/Schema.html" title="WscSdk::Schema (class)">WscSdk::Schema</a></span></p>
|
|
116
|
+
</div>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<h2>
|
|
126
|
+
Instance Method Summary
|
|
127
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
128
|
+
</h2>
|
|
129
|
+
|
|
130
|
+
<ul class="summary">
|
|
131
|
+
|
|
132
|
+
<li class="public ">
|
|
133
|
+
<span class="summary_signature">
|
|
134
|
+
|
|
135
|
+
<a href="#deep_symbolize_keys-instance_method" title="#deep_symbolize_keys (instance method)">#<strong>deep_symbolize_keys</strong> ⇒ Object </a>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
</span>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<span class="summary_desc"><div class='inline'>
|
|
150
|
+
<p>Convert hash keys to symbols.</p>
|
|
151
|
+
</div></span>
|
|
152
|
+
|
|
153
|
+
</li>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<li class="public ">
|
|
157
|
+
<span class="summary_signature">
|
|
158
|
+
|
|
159
|
+
<a href="#deep_transform_keys-instance_method" title="#deep_transform_keys (instance method)">#<strong>deep_transform_keys</strong>(&block) ⇒ Object </a>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
</span>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<span class="summary_desc"><div class='inline'>
|
|
174
|
+
<p>Transform keys as needed.</p>
|
|
175
|
+
</div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</ul>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<div id="instance_method_details" class="method_details_list">
|
|
186
|
+
<h2>Instance Method Details</h2>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<div class="method_details first">
|
|
190
|
+
<h3 class="signature first" id="deep_symbolize_keys-instance_method">
|
|
191
|
+
|
|
192
|
+
#<strong>deep_symbolize_keys</strong> ⇒ <tt>Object</tt>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</h3><div class="docstring">
|
|
199
|
+
<div class="discussion">
|
|
200
|
+
|
|
201
|
+
<p>Convert hash keys to symbols.</p>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
<div class="tags">
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</div><table class="source_code">
|
|
210
|
+
<tr>
|
|
211
|
+
<td>
|
|
212
|
+
<pre class="lines">
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
7
|
|
216
|
+
8
|
|
217
|
+
9</pre>
|
|
218
|
+
</td>
|
|
219
|
+
<td>
|
|
220
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/modifiers/hash.rb', line 7</span>
|
|
221
|
+
|
|
222
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">deep_symbolize_keys</span>
|
|
223
|
+
deep_transform_keys{ |key| key.to_sym <span style="color:#080;font-weight:bold">rescue</span> key }
|
|
224
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
225
|
+
</td>
|
|
226
|
+
</tr>
|
|
227
|
+
</table>
|
|
228
|
+
</div>
|
|
229
|
+
|
|
230
|
+
<div class="method_details ">
|
|
231
|
+
<h3 class="signature " id="deep_transform_keys-instance_method">
|
|
232
|
+
|
|
233
|
+
#<strong>deep_transform_keys</strong>(&block) ⇒ <tt>Object</tt>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</h3><div class="docstring">
|
|
240
|
+
<div class="discussion">
|
|
241
|
+
|
|
242
|
+
<p>Transform keys as needed.</p>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
</div>
|
|
246
|
+
</div>
|
|
247
|
+
<div class="tags">
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
</div><table class="source_code">
|
|
251
|
+
<tr>
|
|
252
|
+
<td>
|
|
253
|
+
<pre class="lines">
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
13
|
|
257
|
+
14
|
|
258
|
+
15
|
|
259
|
+
16
|
|
260
|
+
17
|
|
261
|
+
18
|
|
262
|
+
19</pre>
|
|
263
|
+
</td>
|
|
264
|
+
<td>
|
|
265
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/modifiers/hash.rb', line 13</span>
|
|
266
|
+
|
|
267
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">deep_transform_keys</span>(&block)
|
|
268
|
+
result = {}
|
|
269
|
+
each <span style="color:#080;font-weight:bold">do</span> |key, value|
|
|
270
|
+
result[<span style="color:#080;font-weight:bold">yield</span>(key)] = value.is_a?(<span style="color:#036;font-weight:bold">Hash</span>) ? value.deep_transform_keys(&block) : value
|
|
271
|
+
<span style="color:#080;font-weight:bold">end</span>
|
|
272
|
+
result
|
|
273
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
274
|
+
</td>
|
|
275
|
+
</tr>
|
|
276
|
+
</table>
|
|
277
|
+
</div>
|
|
278
|
+
|
|
279
|
+
</div>
|
|
280
|
+
|
|
281
|
+
</div>
|
|
282
|
+
|
|
283
|
+
<div id="footer">
|
|
284
|
+
Generated on Wed Feb 27 12:57:43 2019 by
|
|
285
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
286
|
+
0.9.18 (ruby-2.3.1).
|
|
287
|
+
</div>
|
|
288
|
+
|
|
289
|
+
</div>
|
|
290
|
+
</body>
|
|
291
|
+
</html>
|
data/doc/WscSdk.html
ADDED
|
@@ -0,0 +1,570 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Wowza Streaming Cloud - SDK Code Documentation</title>
|
|
7
|
+
|
|
8
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
11
|
+
|
|
12
|
+
<link rel="stylesheet" href="css/custom.css" type="text/css" charset="utf-8" />
|
|
13
|
+
|
|
14
|
+
<script type="text/javascript" charset="utf-8">
|
|
15
|
+
pathId = "WscSdk";
|
|
16
|
+
relpath = '';
|
|
17
|
+
</script>
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
</head>
|
|
26
|
+
<body>
|
|
27
|
+
<div id="wowza-wrapper">
|
|
28
|
+
<header>
|
|
29
|
+
<div class="logo">
|
|
30
|
+
<a href="https://www.wowza.com">
|
|
31
|
+
<img src="https://cloud.wowza.com/apidocs/assets/logo.png" alt="Wowza Logo" />
|
|
32
|
+
</a>
|
|
33
|
+
<h1>Wowza Streaming Cloud<br/>SDK Code Documentation</h1>
|
|
34
|
+
<div class="clearfix"></div>
|
|
35
|
+
</div>
|
|
36
|
+
<div class="links">
|
|
37
|
+
<a href="https://www.wowza.com/">Wowza Home</a>
|
|
38
|
+
<a href="https://www.wowza.com/docs">Docs & APIS</a>
|
|
39
|
+
<a href="https://www.wowza.com/community/index.html">Forums</a>
|
|
40
|
+
<a href="https://www.wowza.com/support">Support</a>
|
|
41
|
+
</div>
|
|
42
|
+
<div class="clearfix"></div>
|
|
43
|
+
</header>
|
|
44
|
+
|
|
45
|
+
<div id="content">
|
|
46
|
+
<div class="nav_wrap">
|
|
47
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
48
|
+
<div id="resizer"></div>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
<div id="main" tabindex="-1">
|
|
52
|
+
<div id="header">
|
|
53
|
+
<div id="menu">
|
|
54
|
+
|
|
55
|
+
<a href="_index.html">Index (W)</a> »
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<span class="title">WscSdk</span>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="search">
|
|
63
|
+
|
|
64
|
+
<a class="full_list_link" id="class_list_link"
|
|
65
|
+
href="class_list.html">
|
|
66
|
+
|
|
67
|
+
<svg width="24" height="24">
|
|
68
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
69
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
70
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
71
|
+
</svg>
|
|
72
|
+
</a>
|
|
73
|
+
|
|
74
|
+
</div>
|
|
75
|
+
<div class="clear"></div>
|
|
76
|
+
</div>
|
|
77
|
+
|
|
78
|
+
<div id="content"><h1>Module: WscSdk
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
</h1>
|
|
83
|
+
<div class="box_info">
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/wsc_sdk/enums.rb<span class="defines">,<br />
|
|
98
|
+
lib/wsc_sdk.rb,<br /> lib/wsc_sdk/model.rb,<br /> lib/wsc_sdk/client.rb,<br /> lib/wsc_sdk/errors.rb,<br /> lib/wsc_sdk/schema.rb,<br /> lib/wsc_sdk/version.rb,<br /> lib/wsc_sdk/endpoint.rb,<br /> lib/wsc_sdk/constants.rb,<br /> lib/wsc_sdk/model_list.rb,<br /> lib/wsc_sdk/pagination.rb,<br /> lib/wsc_sdk/models/error.rb,<br /> lib/wsc_sdk/configuration.rb,<br /> lib/wsc_sdk/enums/encoder.rb,<br /> lib/wsc_sdk/models/output.rb,<br /> lib/wsc_sdk/enums/protocol.rb,<br /> lib/wsc_sdk/model_template.rb,<br /> lib/wsc_sdk/modules/loggable.rb,<br /> lib/wsc_sdk/schema_attribute.rb,<br /> lib/wsc_sdk/templates/output.rb,<br /> lib/wsc_sdk/endpoints/outputs.rb,<br /> lib/wsc_sdk/enums/buffer_size.rb,<br /> lib/wsc_sdk/enums/player_type.rb,<br /> lib/wsc_sdk/models/transcoder.rb,<br /> lib/wsc_sdk/enums/billing_mode.rb,<br /> lib/wsc_sdk/enums/idle_timeout.rb,<br /> lib/wsc_sdk/models/live_stream.rb,<br /> lib/wsc_sdk/enums/delivery_type.rb,<br /> lib/wsc_sdk/enums/image_position.rb,<br /> lib/wsc_sdk/enums/wowza_provider.rb,<br /> lib/wsc_sdk/models/stream_target.rb,<br /> lib/wsc_sdk/modules/api_response.rb,<br /> lib/wsc_sdk/templates/transcoder.rb,<br /> lib/wsc_sdk/endpoints/transcoders.rb,<br /> lib/wsc_sdk/enums/custom_provider.rb,<br /> lib/wsc_sdk/enums/delivery_method.rb,<br /> lib/wsc_sdk/enums/transcoder_type.rb,<br /> lib/wsc_sdk/templates/live_stream.rb,<br /> lib/wsc_sdk/endpoints/live_streams.rb,<br /> lib/wsc_sdk/models/transcoder_state.rb,<br /> lib/wsc_sdk/models/transcoder_stats.rb,<br /> lib/wsc_sdk/endpoints/stream_targets.rb,<br /> lib/wsc_sdk/enums/broadcast_location.rb,<br /> lib/wsc_sdk/models/live_stream_state.rb,<br /> lib/wsc_sdk/models/live_stream_stats.rb,<br /> lib/wsc_sdk/models/ull_stream_target.rb,<br /> lib/wsc_sdk/enums/closed_caption_type.rb,<br /> lib/wsc_sdk/models/wowza_stream_target.rb,<br /> lib/wsc_sdk/models/custom_stream_target.rb,<br /> lib/wsc_sdk/models/output_stream_target.rb,<br /> lib/wsc_sdk/templates/ull_stream_target.rb,<br /> lib/wsc_sdk/endpoints/ull_stream_targets.rb,<br /> lib/wsc_sdk/models/transcoder_float_stat.rb,<br /> lib/wsc_sdk/models/transcoder_string_stat.rb,<br /> lib/wsc_sdk/templates/wowza_stream_target.rb,<br /> lib/wsc_sdk/endpoints/wowza_stream_targets.rb,<br /> lib/wsc_sdk/enums/target_delivery_protocol.rb,<br /> lib/wsc_sdk/models/transcoder_boolean_stat.rb,<br /> lib/wsc_sdk/models/transcoder_integer_stat.rb,<br /> lib/wsc_sdk/templates/custom_stream_target.rb,<br /> lib/wsc_sdk/endpoints/custom_stream_targets.rb,<br /> lib/wsc_sdk/endpoints/output_stream_targets.rb,<br /> lib/wsc_sdk/models/transcoder_thumbnail_url.rb,<br /> lib/wsc_sdk/models/live_stream_thumbnail_url.rb,<br /> lib/wsc_sdk/models/transcoder_connection_code.rb,<br /> lib/wsc_sdk/modules/transcoder_shared_methods.rb,<br /> lib/wsc_sdk/models/live_stream_connection_code.rb,<br /> lib/wsc_sdk/models/transcoder_stream_target_state.rb</span>
|
|
99
|
+
</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>> This code and all components © 2015 – 2019 Wowza Media Systems, LLC.
|
|
108
|
+
All rights reserved. > This code is licensed pursuant to the BSD
|
|
109
|
+
3-Clause License.</p>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
</div>
|
|
113
|
+
</div>
|
|
114
|
+
<div class="tags">
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</div><h2>Defined Under Namespace</h2>
|
|
118
|
+
<p class="children">
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="WscSdk/ApiResponse.html" title="WscSdk::ApiResponse (module)">ApiResponse</a></span>, <span class='object_link'><a href="WscSdk/Endpoints.html" title="WscSdk::Endpoints (module)">Endpoints</a></span>, <span class='object_link'><a href="WscSdk/Enums.html" title="WscSdk::Enums (module)">Enums</a></span>, <span class='object_link'><a href="WscSdk/Errors.html" title="WscSdk::Errors (module)">Errors</a></span>, <span class='object_link'><a href="WscSdk/Loggable.html" title="WscSdk::Loggable (module)">Loggable</a></span>, <span class='object_link'><a href="WscSdk/Models.html" title="WscSdk::Models (module)">Models</a></span>, <span class='object_link'><a href="WscSdk/Templates.html" title="WscSdk::Templates (module)">Templates</a></span>, <span class='object_link'><a href="WscSdk/TranscoderSharedMethods.html" title="WscSdk::TranscoderSharedMethods (module)">TranscoderSharedMethods</a></span>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="WscSdk/Client.html" title="WscSdk::Client (class)">Client</a></span>, <span class='object_link'><a href="WscSdk/Configuration.html" title="WscSdk::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="WscSdk/Endpoint.html" title="WscSdk::Endpoint (class)">Endpoint</a></span>, <span class='object_link'><a href="WscSdk/Model.html" title="WscSdk::Model (class)">Model</a></span>, <span class='object_link'><a href="WscSdk/ModelList.html" title="WscSdk::ModelList (class)">ModelList</a></span>, <span class='object_link'><a href="WscSdk/ModelTemplate.html" title="WscSdk::ModelTemplate (class)">ModelTemplate</a></span>, <span class='object_link'><a href="WscSdk/Pagination.html" title="WscSdk::Pagination (class)">Pagination</a></span>, <span class='object_link'><a href="WscSdk/Schema.html" title="WscSdk::Schema (class)">Schema</a></span>, <span class='object_link'><a href="WscSdk/SchemaAttribute.html" title="WscSdk::SchemaAttribute (class)">SchemaAttribute</a></span>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
</p>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<h2>
|
|
132
|
+
Constant Summary
|
|
133
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
134
|
+
</h2>
|
|
135
|
+
|
|
136
|
+
<dl class="constants">
|
|
137
|
+
|
|
138
|
+
<dt id="VERSION-constant" class="">VERSION =
|
|
139
|
+
<div class="docstring">
|
|
140
|
+
<div class="discussion">
|
|
141
|
+
|
|
142
|
+
<p>The current verison of the SDK.</p>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tags">
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</div>
|
|
151
|
+
</dt>
|
|
152
|
+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">1.3.0</span><span style="color:#710">"</span></span></pre></dd>
|
|
153
|
+
|
|
154
|
+
<dt id="SDK_NAME-constant" class="">SDK_NAME =
|
|
155
|
+
<div class="docstring">
|
|
156
|
+
<div class="discussion">
|
|
157
|
+
|
|
158
|
+
<p>The name of the SDK.</p>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</div>
|
|
162
|
+
</div>
|
|
163
|
+
<div class="tags">
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</div>
|
|
167
|
+
</dt>
|
|
168
|
+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Wowza Streaming Cloud SDK</span><span style="color:#710">"</span></span></pre></dd>
|
|
169
|
+
|
|
170
|
+
<dt id="PATH_VERSION-constant" class="">PATH_VERSION =
|
|
171
|
+
<div class="docstring">
|
|
172
|
+
<div class="discussion">
|
|
173
|
+
|
|
174
|
+
<p>The default version to use when generating API requests.</p>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</div>
|
|
178
|
+
</div>
|
|
179
|
+
<div class="tags">
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
</div>
|
|
183
|
+
</dt>
|
|
184
|
+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">v</span><span style="color:#710">"</span></span> << <span style="color:#036;font-weight:bold">VERSION</span>.split(<span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">.</span><span style="color:#710">"</span></span>)[<span style="color:#00D">0</span>..<span style="color:#00D">1</span>].join(<span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">.</span><span style="color:#710">"</span></span>)</pre></dd>
|
|
185
|
+
|
|
186
|
+
<dt id="HOSTNAME-constant" class="">HOSTNAME =
|
|
187
|
+
<div class="docstring">
|
|
188
|
+
<div class="discussion">
|
|
189
|
+
|
|
190
|
+
<p>The default hostname to use when generating API requests.</p>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
</div>
|
|
194
|
+
</div>
|
|
195
|
+
<div class="tags">
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</div>
|
|
199
|
+
</dt>
|
|
200
|
+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">https://api.cloud.wowza.com</span><span style="color:#710">"</span></span></pre></dd>
|
|
201
|
+
|
|
202
|
+
<dt id="PRODUCTION_HOSTNAME-constant" class="">PRODUCTION_HOSTNAME =
|
|
203
|
+
<div class="docstring">
|
|
204
|
+
<div class="discussion">
|
|
205
|
+
|
|
206
|
+
<p>The hostname of the Production server. This is an alias for
|
|
207
|
+
WscSdk::HOSTNAME</p>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
</div>
|
|
211
|
+
</div>
|
|
212
|
+
<div class="tags">
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</div>
|
|
216
|
+
</dt>
|
|
217
|
+
<dd><pre class="code"><span style="color:#036;font-weight:bold">HOSTNAME</span></pre></dd>
|
|
218
|
+
|
|
219
|
+
<dt id="SANDBOX_HOSTNAME-constant" class="">SANDBOX_HOSTNAME =
|
|
220
|
+
<div class="docstring">
|
|
221
|
+
<div class="discussion">
|
|
222
|
+
|
|
223
|
+
<p>The hostname of the Sandbox server.</p>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
</div>
|
|
227
|
+
</div>
|
|
228
|
+
<div class="tags">
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</div>
|
|
232
|
+
</dt>
|
|
233
|
+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">https://api-sandbox.cloud.wowza.com</span><span style="color:#710">"</span></span></pre></dd>
|
|
234
|
+
|
|
235
|
+
<dt id="USER_AGENT-constant" class="">USER_AGENT =
|
|
236
|
+
<div class="docstring">
|
|
237
|
+
<div class="discussion">
|
|
238
|
+
|
|
239
|
+
<p>The user agent to report when generating API requests.</p>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
</div>
|
|
243
|
+
</div>
|
|
244
|
+
<div class="tags">
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
</div>
|
|
248
|
+
</dt>
|
|
249
|
+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">{</span><span style="color:#b0b">\"</span><span style="color:#D20">name</span><span style="color:#b0b">\"</span><span style="color:#D20">: </span><span style="color:#b0b">\"</span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span><span style="color:#036;font-weight:bold">SDK_NAME</span><span style="font-weight:bold;color:#666">}</span></span><span style="color:#b0b">\"</span><span style="color:#D20">, </span><span style="color:#b0b">\"</span><span style="color:#D20">version</span><span style="color:#b0b">\"</span><span style="color:#D20">: </span><span style="color:#b0b">\"</span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span><span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">VERSION</span><span style="font-weight:bold;color:#666">}</span></span><span style="color:#b0b">\"</span><span style="color:#D20">, </span><span style="color:#b0b">\"</span><span style="color:#D20">platform</span><span style="color:#b0b">\"</span><span style="color:#D20">: </span><span style="color:#b0b">\"</span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span><span style="color:#069">RUBY_PLATFORM</span><span style="font-weight:bold;color:#666">}</span></span><span style="color:#b0b">\"</span><span style="color:#D20">, </span><span style="color:#b0b">\"</span><span style="color:#D20">engine</span><span style="color:#b0b">\"</span><span style="color:#D20">: </span><span style="color:#b0b">\"</span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span><span style="color:#069">RUBY_ENGINE</span><span style="font-weight:bold;color:#666">}</span></span><span style="color:#b0b">\"</span><span style="color:#D20">}</span><span style="color:#710">"</span></span></pre></dd>
|
|
250
|
+
|
|
251
|
+
</dl>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
258
|
+
<ul class="summary">
|
|
259
|
+
|
|
260
|
+
<li class="public ">
|
|
261
|
+
<span class="summary_signature">
|
|
262
|
+
|
|
263
|
+
<a href="#configuration-class_method" title="configuration (class method)">.<strong>configuration</strong> ⇒ WscSdk::Configuration </a>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
</span>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class="summary_desc"><div class='inline'>
|
|
281
|
+
<p>Get the SDK configuration object.</p>
|
|
282
|
+
</div></span>
|
|
283
|
+
|
|
284
|
+
</li>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</ul>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
<h2>
|
|
294
|
+
Class Method Summary
|
|
295
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
296
|
+
</h2>
|
|
297
|
+
|
|
298
|
+
<ul class="summary">
|
|
299
|
+
|
|
300
|
+
<li class="public ">
|
|
301
|
+
<span class="summary_signature">
|
|
302
|
+
|
|
303
|
+
<a href="#client-class_method" title="client (class method)">.<strong>client</strong> ⇒ WscSdk::Client </a>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
</span>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
<span class="summary_desc"><div class='inline'>
|
|
318
|
+
<p>Returns an instance of the client configured using the SDK configuration.</p>
|
|
319
|
+
</div></span>
|
|
320
|
+
|
|
321
|
+
</li>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
<li class="public ">
|
|
325
|
+
<span class="summary_signature">
|
|
326
|
+
|
|
327
|
+
<a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|configuration| ... } ⇒ Object </a>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
</span>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
<span class="summary_desc"><div class='inline'>
|
|
342
|
+
<p>Provides a mechanism to configure the SDK given a block.</p>
|
|
343
|
+
</div></span>
|
|
344
|
+
|
|
345
|
+
</li>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
</ul>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
<div id="class_attr_details" class="attr_details">
|
|
353
|
+
<h2>Class Attribute Details</h2>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<span id="configuration=-class_method"></span>
|
|
357
|
+
<div class="method_details first">
|
|
358
|
+
<h3 class="signature first" id="configuration-class_method">
|
|
359
|
+
|
|
360
|
+
.<strong>configuration</strong> ⇒ <tt><span class='object_link'><a href="WscSdk/Configuration.html" title="WscSdk::Configuration (class)">WscSdk::Configuration</a></span></tt>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
</h3><div class="docstring">
|
|
367
|
+
<div class="discussion">
|
|
368
|
+
|
|
369
|
+
<p>Get the SDK configuration object.</p>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
</div>
|
|
373
|
+
</div>
|
|
374
|
+
<div class="tags">
|
|
375
|
+
|
|
376
|
+
<p class="tag_title">Returns:</p>
|
|
377
|
+
<ul class="return">
|
|
378
|
+
|
|
379
|
+
<li>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<span class='type'>(<tt><span class='object_link'><a href="WscSdk/Configuration.html" title="WscSdk::Configuration (class)">WscSdk::Configuration</a></span></tt>)</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
—
|
|
387
|
+
<div class='inline'>
|
|
388
|
+
<p>The SDK configuration object.</p>
|
|
389
|
+
</div>
|
|
390
|
+
|
|
391
|
+
</li>
|
|
392
|
+
|
|
393
|
+
</ul>
|
|
394
|
+
|
|
395
|
+
</div><table class="source_code">
|
|
396
|
+
<tr>
|
|
397
|
+
<td>
|
|
398
|
+
<pre class="lines">
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
56
|
|
402
|
+
57
|
|
403
|
+
58</pre>
|
|
404
|
+
</td>
|
|
405
|
+
<td>
|
|
406
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk.rb', line 56</span>
|
|
407
|
+
|
|
408
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">configuration</span>
|
|
409
|
+
<span style="color:#33B">@configuration</span> ||= <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Configuration</span>.new
|
|
410
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
411
|
+
</td>
|
|
412
|
+
</tr>
|
|
413
|
+
</table>
|
|
414
|
+
</div>
|
|
415
|
+
|
|
416
|
+
</div>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
<div id="class_method_details" class="method_details_list">
|
|
420
|
+
<h2>Class Method Details</h2>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<div class="method_details first">
|
|
424
|
+
<h3 class="signature first" id="client-class_method">
|
|
425
|
+
|
|
426
|
+
.<strong>client</strong> ⇒ <tt><span class='object_link'><a href="WscSdk/Client.html" title="WscSdk::Client (class)">WscSdk::Client</a></span></tt>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</h3><div class="docstring">
|
|
433
|
+
<div class="discussion">
|
|
434
|
+
|
|
435
|
+
<p>Returns an instance of the client configured using the SDK configuration</p>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
</div>
|
|
439
|
+
</div>
|
|
440
|
+
<div class="tags">
|
|
441
|
+
|
|
442
|
+
<p class="tag_title">Returns:</p>
|
|
443
|
+
<ul class="return">
|
|
444
|
+
|
|
445
|
+
<li>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<span class='type'>(<tt><span class='object_link'><a href="WscSdk/Client.html" title="WscSdk::Client (class)">WscSdk::Client</a></span></tt>)</span>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
—
|
|
453
|
+
<div class='inline'>
|
|
454
|
+
<p>An instance of the client object configured using the SDK configuration.</p>
|
|
455
|
+
</div>
|
|
456
|
+
|
|
457
|
+
</li>
|
|
458
|
+
|
|
459
|
+
</ul>
|
|
460
|
+
|
|
461
|
+
</div><table class="source_code">
|
|
462
|
+
<tr>
|
|
463
|
+
<td>
|
|
464
|
+
<pre class="lines">
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
77
|
|
468
|
+
78
|
|
469
|
+
79</pre>
|
|
470
|
+
</td>
|
|
471
|
+
<td>
|
|
472
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk.rb', line 77</span>
|
|
473
|
+
|
|
474
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">client</span>
|
|
475
|
+
<span style="color:#33B">@client</span> ||= <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Client</span>.configured_instance
|
|
476
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
477
|
+
</td>
|
|
478
|
+
</tr>
|
|
479
|
+
</table>
|
|
480
|
+
</div>
|
|
481
|
+
|
|
482
|
+
<div class="method_details ">
|
|
483
|
+
<h3 class="signature " id="configure-class_method">
|
|
484
|
+
|
|
485
|
+
.<strong>configure</strong> {|configuration| ... } ⇒ <tt>Object</tt>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
</h3><div class="docstring">
|
|
492
|
+
<div class="discussion">
|
|
493
|
+
|
|
494
|
+
<p>Provides a mechanism to configure the SDK given a block.</p>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</div>
|
|
498
|
+
</div>
|
|
499
|
+
<div class="tags">
|
|
500
|
+
|
|
501
|
+
<p class="tag_title">Yields:</p>
|
|
502
|
+
<ul class="yield">
|
|
503
|
+
|
|
504
|
+
<li>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
<span class='type'>(<tt><span class='object_link'><a href="#configuration-class_method" title="WscSdk.configuration (method)">configuration</a></span></tt>)</span>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
—
|
|
512
|
+
<div class='inline'>
|
|
513
|
+
<p>Gives a configuration object to the block so it can be setup properly.</p>
|
|
514
|
+
</div>
|
|
515
|
+
|
|
516
|
+
</li>
|
|
517
|
+
|
|
518
|
+
</ul>
|
|
519
|
+
<p class="tag_title">Yield Parameters:</p>
|
|
520
|
+
<ul class="yieldparam">
|
|
521
|
+
|
|
522
|
+
<li>
|
|
523
|
+
|
|
524
|
+
<span class='name'>configuration</span>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<span class='type'>(<tt><span class='object_link'><a href="WscSdk/Configuration.html" title="WscSdk::Configuration (class)">WscSdk::Configuration</a></span></tt>)</span>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
—
|
|
532
|
+
<div class='inline'>
|
|
533
|
+
<p>The SDK configuration object.</p>
|
|
534
|
+
</div>
|
|
535
|
+
|
|
536
|
+
</li>
|
|
537
|
+
|
|
538
|
+
</ul>
|
|
539
|
+
|
|
540
|
+
</div><table class="source_code">
|
|
541
|
+
<tr>
|
|
542
|
+
<td>
|
|
543
|
+
<pre class="lines">
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
68
|
|
547
|
+
69
|
|
548
|
+
70</pre>
|
|
549
|
+
</td>
|
|
550
|
+
<td>
|
|
551
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk.rb', line 68</span>
|
|
552
|
+
|
|
553
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">configure</span>
|
|
554
|
+
<span style="color:#080;font-weight:bold">yield</span>(configuration)
|
|
555
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
556
|
+
</td>
|
|
557
|
+
</tr>
|
|
558
|
+
</table>
|
|
559
|
+
</div>
|
|
560
|
+
|
|
561
|
+
</div>
|
|
562
|
+
|
|
563
|
+
</div>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</div>
|
|
567
|
+
</div>
|
|
568
|
+
</div>
|
|
569
|
+
</body>
|
|
570
|
+
</html>
|