summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLAppInfo.html
blob: a72c38363146a3b99fb649ddff0c8e45470759f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<h1>SDLAppInfo Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-+currentAppInfo">+currentAppInfo</a></li>
  <li><a href="#section-appDisplayName">appDisplayName</a></li>
  <li><a href="#section-appBundleID">appBundleID</a></li>
  <li><a href="#section-appVersion">appVersion</a></li>
</ul>

<h3>Overview</h3>

<p>A struct used in register app interface. Contains detailed information about the registered application.</p>


<section class="section task-group-section">
  <h3 id="section-+currentAppInfo">
      +currentAppInfo
  </h3>
  
  <p>Convenience init with no parameters</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">currentAppInfo</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">current</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>

  
  
  <div>
    <h4>Return Value</h4>
    <p>An SDLAppInfo object</p>
  </div>
  
  <h3 id="section-appDisplayName">
      appDisplayName
  </h3>
  
  <p>The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).</p>

<p>Required</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appDisplayName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">appDisplayName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-appBundleID">
      appBundleID
  </h3>
  
  <p>The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform.</p>

<p>Required</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appBundleID</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">appBundleID</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-appVersion">
      appVersion
  </h3>
  
  <p>Represents the build version number of this particular mobile app.</p>

<p>Required</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appVersion</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">appVersion</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>