PageRenderTime 44ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/FacebookSDK/DocSets/FacebookSDK-4_14-for-iOS.docset/Contents/Resources/Documents/Protocols/FBSDKSharing.html

https://gitlab.com/amrk0320/sherbet
HTML | 471 lines | 272 code | 199 blank | 0 comment | 0 complexity | 3cad0e7fb3022f8a6a7a95b82c2f06e5 MD5 | raw file
    

  1. <!DOCTYPE HTML>
    2. 

  2. <html>
    3. 

  3. 	<head>
    4. 

  4. 		<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
    5. 

  5. 		<title>FBSDKSharing Protocol Reference</title>
    6. 

  6. 		<meta id="xcode-display" name="xcode-display" content="render"/>
    7. 

  7. 		<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
    8. 

  8. 		<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
    9. 

  9. 		<meta name="generator" content="appledoc 2.2 (build 963)" />
    10. 

  10. 	</head>
    11. 

  11. 	<body>
    12. 

  12. 		<header id="top_header">
    13. 

  13. 			<div id="library" class="hideInXcode">
    14. 

  14. 				<h1><a id="libraryTitle" href="../index.html">Facebook SDK 4.14 for iOS </a></h1>
    15. 

  15. 				<a id="developerHome" href="../index.html">Facebook</a>
    16. 

  16. 			</div>
    17. 

  17. 			
    18. 

  18. 			<div id="title" role="banner">
    19. 

  19. 				<h1 class="hideInXcode">FBSDKSharing Protocol Reference</h1>
    20. 

  20. 			</div>
    21. 

  21. 			<ul id="headerButtons" role="toolbar">
    22. 

  22. 				<li id="toc_button">
    23. 

  23. 					<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
    24. 

  24. 				</li>
    25. 

  25. 				<li id="jumpto_button" role="navigation">
    26. 

  26. 					<select id="jumpTo">
    27. 

  27. 	<option value="top">Jump To&#133;</option>
    28. 

  28. 	
    29. 

  29. 	<option value="overview">Overview</option>
    30. 

  30. 	
    31. 

  31. 	
    32. 

  32. 	
    33. 

  33. 	
    34. 

  34. 	<option value="tasks">Tasks</option>
    35. 

  35. 	
    36. 

  36. 	
    37. 

  37. 	
    38. 

  38. 	
    39. 

  39. 	
    40. 

  40. 	<option value="properties">Properties</option>
    41. 

  41. 	
    42. 

  42. 	<option value="//api/name/delegate">&nbsp;&nbsp;&nbsp;&nbsp;delegate</option>
    43. 

  43. 	
    44. 

  44. 	<option value="//api/name/shareContent">&nbsp;&nbsp;&nbsp;&nbsp;shareContent</option>
    45. 

  45. 	
    46. 

  46. 	<option value="//api/name/shouldFailOnDataError">&nbsp;&nbsp;&nbsp;&nbsp;shouldFailOnDataError</option>
    47. 

  47. 	
    48. 

  48. 	
    49. 

  49. 	
    50. 

  50. 	
    51. 

  51. 	
    52. 

  52. 	
    53. 

  53. 	<option value="instance_methods">Instance Methods</option>
    54. 

  54. 	
    55. 

  55. 	<option value="//api/name/validateWithError:">&nbsp;&nbsp;&nbsp;&nbsp;- validateWithError:</option>
    56. 

  56. 	
    57. 

  57. 	
    58. 

  58. 	
    59. 

  59. </select>
    60. 

  60. 				</li>
    61. 

  61. 			</ul>
    62. 

  62. 		</header>
    63. 

  63. 		<nav id="tocContainer" class="isShowingTOC">
    64. 

  64. 			<ul id="toc" role="tree">
    65. 

  65. 				
    66. 

  66. <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
    67. 

  67. 

  68. 

  69. 

  70. 

  71. <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
    72. 

  72. 	
    73. 

  73. </ul></li>
    74. 

  74. 

  75. 

  76. 

  77. 

  78. 

  79. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
    80. 

  80. 	
    81. 

  81. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegate">delegate</a></span></li>
    82. 

  82. 	
    83. 

  83. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/shareContent">shareContent</a></span></li>
    84. 

  84. 	
    85. 

  85. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/shouldFailOnDataError">shouldFailOnDataError</a></span></li>
    86. 

  86. 	
    87. 

  87. </ul></li>
    88. 

  88. 

  89. 

  90. 

  91. 

  92. 

  93. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
    94. 

  94. 	
    95. 

  95. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/validateWithError:">validateWithError:</a></span></li>
    96. 

  96. 	
    97. 

  97. </ul></li>
    98. 

  98. 

  99. 

  100. 			</ul>
    101. 

  101. 		</nav>
    102. 

  102. 		<article>
    103. 

  103. 			<div id="contents" class="isShowingTOC" role="main">
    104. 

  104. 				<a title="FBSDKSharing Protocol Reference" name="top"></a>
    105. 

  105. 				<div class="main-navigation navigation-top">
    106. 

  106. 					<ul>
    107. 

  107. 	<li><a href="../index.html">Index</a></li>
    108. 

  108. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    109. 

  109. </ul>
    110. 

  110. 				</div>
    111. 

  111. 				<div id="header">
    112. 

  112. 					<div class="section-header">
    113. 

  113. 						<h1 class="title title-header">FBSDKSharing Protocol Reference</h1>
    114. 

  114. 					</div>		
    115. 

  115. 				</div>
    116. 

  116. 				<div id="container">	
    117. 

  117. 					
    118. 

  118. 					<div class="section section-specification"><table cellspacing="0"><tbody>
    119. 

  119. 						<tr>
    120. 

  120. 	<td class="specification-title">Conforms to</td>
    121. 

  121. 	<td class="specification-value">NSObject</td>
    122. 

  122. </tr><tr>
    123. 

  123. 	<td class="specification-title">Declared in</td>
    124. 

  124. 	<td class="specification-value">FBSDKSharing.h</td>
    125. 

  125. </tr>
    126. 

  126. 						</tbody></table></div>
    127. 

  127. 					
    128. 

  128.                     
    129. 

  129.                     
    130. 

  130. 					
    131. 

  131. 					
    132. 

  132. 					
    133. 

  133. 					
    134. 

  134. 					
    135. 

  135. 					<div class="section section-tasks">
    136. 

  136. 						<a title="Tasks" name="tasks"></a>
    137. 

  137. 						<h2 class="subtitle subtitle-tasks">Tasks</h2>
    138. 

  138. 						
    139. 

  139. 						
    140. 

  140. 						
    141. 

  141. 						
    142. 

  142. 

  143. 						<ul class="task-list">
    144. 

  144. 							<li>
    145. 

  145. 	<span class="tooltip">
    146. 

  146. 		<code><a href="#//api/name/delegate">&nbsp;&nbsp;delegate</a></code>
    147. 

  147. 	</span>
    148. 

  148. 	<span class="task-item-suffix">property</span>
    149. 

  149. 	<span class="task-item-suffix">required method</span>
    150. 

  150. </li><li>
    151. 

  151. 	<span class="tooltip">
    152. 

  152. 		<code><a href="#//api/name/shareContent">&nbsp;&nbsp;shareContent</a></code>
    153. 

  153. 	</span>
    154. 

  154. 	<span class="task-item-suffix">property</span>
    155. 

  155. 	<span class="task-item-suffix">required method</span>
    156. 

  156. </li><li>
    157. 

  157. 	<span class="tooltip">
    158. 

  158. 		<code><a href="#//api/name/shouldFailOnDataError">&nbsp;&nbsp;shouldFailOnDataError</a></code>
    159. 

  159. 	</span>
    160. 

  160. 	<span class="task-item-suffix">property</span>
    161. 

  161. 	<span class="task-item-suffix">required method</span>
    162. 

  162. </li><li>
    163. 

  163. 	<span class="tooltip">
    164. 

  164. 		<code><a href="#//api/name/validateWithError:">&ndash;&nbsp;validateWithError:</a></code>
    165. 

  165. 	</span>
    166. 

  166. 	
    167. 

  167. 	<span class="task-item-suffix">required method</span>
    168. 

  168. </li>
    169. 

  169. 						</ul>
    170. 

  170. 						
    171. 

  171. 					</div>
    172. 

  172. 					
    173. 

  173. 					
    174. 

  174. 					
    175. 

  175. 					
    176. 

  176. 					
    177. 

  177. 					<div class="section section-methods">
    178. 

  178. 						<a title="Properties" name="properties"></a>
    179. 

  179. 						<h2 class="subtitle subtitle-methods">Properties</h2>
    180. 

  180. 						
    181. 

  181. 						<div class="section-method">
    182. 

  182. 	<a name="//api/name/delegate" title="delegate"></a>
    183. 

  183. 	<h3 class="subsubtitle method-title">delegate</h3>
    184. 

  184. 	
    185. 

  185. 	
    186. 

  186. 	
    187. 

  187. 	<div class="method-subsection brief-description">
    188. 

  188. 		<p>The receiver&rsquo;s delegate or nil if it doesn&rsquo;t have a delegate.</p>
    189. 

  189. 	</div>		
    190. 

  190. 	
    191. 

  191.     
    192. 

  192. 

  193. 	<div class="method-subsection method-declaration"><code>@property (nonatomic, weak) id&lt;FBSDKSharingDelegate&gt; delegate</code></div>
    194. 

  194. 

  195.     
    196. 

  196. 	
    197. 

  197. 	
    198. 

  198. 	
    199. 

  199. 	
    200. 

  200. 	
    201. 

  201. 	
    202. 

  202. 	
    203. 

  203. 	
    204. 

  204. 	
    205. 

  205. 	
    206. 

  206. 	
    207. 

  207. 	
    208. 

  208. 	
    209. 

  209. 	<div class="method-subsection declared-in-section">
    210. 

  210. 		<h4 class="method-subtitle">Declared In</h4>
    211. 

  211. 		<code class="declared-in-ref">FBSDKSharing.h</code><br />
    212. 

  212. 	</div>				
    213. 

  213. 	
    214. 

  214. 	
    215. 

  215. </div>
    216. 

  216. 						
    217. 

  217. 						<div class="section-method">
    218. 

  218. 	<a name="//api/name/shareContent" title="shareContent"></a>
    219. 

  219. 	<h3 class="subsubtitle method-title">shareContent</h3>
    220. 

  220. 	
    221. 

  221. 	
    222. 

  222. 	
    223. 

  223. 	<div class="method-subsection brief-description">
    224. 

  224. 		<p>The content to be shared.</p>
    225. 

  225. 	</div>		
    226. 

  226. 	
    227. 

  227.     
    228. 

  228. 

  229. 	<div class="method-subsection method-declaration"><code>@property (nonatomic, copy) id&lt;FBSDKSharingContent&gt; shareContent</code></div>
    230. 

  230. 

  231.     
    232. 

  232. 	
    233. 

  233. 	
    234. 

  234. 	
    235. 

  235. 	
    236. 

  236. 	
    237. 

  237. 	
    238. 

  238. 	
    239. 

  239. 	
    240. 

  240. 	
    241. 

  241. 	
    242. 

  242. 	
    243. 

  243. 	
    244. 

  244. 	
    245. 

  245. 	<div class="method-subsection declared-in-section">
    246. 

  246. 		<h4 class="method-subtitle">Declared In</h4>
    247. 

  247. 		<code class="declared-in-ref">FBSDKSharing.h</code><br />
    248. 

  248. 	</div>				
    249. 

  249. 	
    250. 

  250. 	
    251. 

  251. </div>
    252. 

  252. 						
    253. 

  253. 						<div class="section-method">
    254. 

  254. 	<a name="//api/name/shouldFailOnDataError" title="shouldFailOnDataError"></a>
    255. 

  255. 	<h3 class="subsubtitle method-title">shouldFailOnDataError</h3>
    256. 

  256. 	
    257. 

  257. 	
    258. 

  258. 	
    259. 

  259. 	<div class="method-subsection brief-description">
    260. 

  260. 		<p>A Boolean value that indicates whether the receiver should fail if it finds an error with the share content.</p>
    261. 

  261. 	</div>		
    262. 

  262. 	
    263. 

  263.     
    264. 

  264. 

  265. 	<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) BOOL shouldFailOnDataError</code></div>
    266. 

  266. 

  267.     
    268. 

  268. 	
    269. 

  269. 	
    270. 

  270. 	
    271. 

  271. 	
    272. 

  272. 	
    273. 

  273. 	
    274. 

  274. 	
    275. 

  275. 	<div class="method-subsection discussion-section">
    276. 

  276. 		<h4 class="method-subtitle">Discussion</h4>
    277. 

  277. 		<p>If NO, the sharer will still be displayed without the data that was mis-configured.  For example, an
    278. 

  278. invalid placeID specified on the shareContent would produce a data error.</p>
    279. 

  279. 	</div>
    280. 

  280. 	
    281. 

  281. 	
    282. 

  282. 	
    283. 

  283. 	
    284. 

  284. 	
    285. 

  285. 	
    286. 

  286. 	
    287. 

  287. 	<div class="method-subsection declared-in-section">
    288. 

  288. 		<h4 class="method-subtitle">Declared In</h4>
    289. 

  289. 		<code class="declared-in-ref">FBSDKSharing.h</code><br />
    290. 

  290. 	</div>				
    291. 

  291. 	
    292. 

  292. 	
    293. 

  293. </div>
    294. 

  294. 						
    295. 

  295. 					</div>
    296. 

  296. 					
    297. 

  297. 					
    298. 

  298. 					
    299. 

  299. 					
    300. 

  300. 					
    301. 

  301. 					<div class="section section-methods">
    302. 

  302. 						<a title="Instance Methods" name="instance_methods"></a>
    303. 

  303. 						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
    304. 

  304. 						
    305. 

  305. 						<div class="section-method">
    306. 

  306. 	<a name="//api/name/validateWithError:" title="validateWithError:"></a>
    307. 

  307. 	<h3 class="subsubtitle method-title">validateWithError:</h3>
    308. 

  308. 	
    309. 

  309. 	
    310. 

  310. 	
    311. 

  311. 	<div class="method-subsection brief-description">
    312. 

  312. 		<p>Validates the content on the receiver.</p>
    313. 

  313. 	</div>		
    314. 

  314. 	
    315. 

  315.     
    316. 

  316. 

  317. 	<div class="method-subsection method-declaration"><code>- (BOOL)validateWithError:(NSError **)<em>errorRef</em></code></div>
    318. 

  318. 

  319.     
    320. 

  320. 	
    321. 

  321. 	<div class="method-subsection arguments-section parameters">
    322. 

  322. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    323. 

  323. 		
    324. 

  324. 		<dl class="argument-def parameter-def">
    325. 

  325. 			<dt><em>errorRef</em></dt>
    326. 

  326. 			<dd><p>If an error occurs, upon return contains an NSError object that describes the problem.</p></dd>
    327. 

  327. 		</dl>
    328. 

  328. 		
    329. 

  329. 	</div>
    330. 

  330. 	
    331. 

  331. 	
    332. 

  332. 	
    333. 

  333. 	<div class="method-subsection return">
    334. 

  334. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    335. 

  335. 		<p>YES if the content is valid, otherwise NO.</p>
    336. 

  336. 	</div>
    337. 

  337. 	
    338. 

  338. 	
    339. 

  339. 	
    340. 

  340. 	
    341. 

  341. 	
    342. 

  342. 	
    343. 

  343. 	
    344. 

  344. 	
    345. 

  345. 	
    346. 

  346. 	
    347. 

  347. 	
    348. 

  348. 	<div class="method-subsection declared-in-section">
    349. 

  349. 		<h4 class="method-subtitle">Declared In</h4>
    350. 

  350. 		<code class="declared-in-ref">FBSDKSharing.h</code><br />
    351. 

  351. 	</div>				
    352. 

  352. 	
    353. 

  353. 	
    354. 

  354. </div>
    355. 

  355. 						
    356. 

  356. 					</div>
    357. 

  357. 					
    358. 

  358. 					
    359. 

  359.                     
    360. 

  360.                     
    361. 

  361. 				</div>
    362. 

  362. 				<div class="main-navigation navigation-bottom">
    363. 

  363. 					<ul>
    364. 

  364. 	<li><a href="../index.html">Index</a></li>
    365. 

  365. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    366. 

  366. </ul>
    367. 

  367. 				</div>
    368. 

  368. 				<div id="footer">
    369. 

  369. 					<hr />
    370. 

  370. 					<div class="footer-copyright">
    371. 

  371. 						<p><span class="copyright">&copy; 2016 Facebook. All rights reserved. (Last updated: 2016-07-12)</span><br />
    372. 

  372. 						
    373. 

  373. 						<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 963)</a>.</span></p>
    374. 

  374. 						
    375. 

  375. 					</div>
    376. 

  376. 				</div>
    377. 

  377. 			</div>
    378. 

  378. 		</article>
    379. 

  379. 		<script type="text/javascript">
    380. 

  380. 			function jumpToChange()
    381. 

  381. 			{
    382. 

  382. 				window.location.hash = this.options[this.selectedIndex].value;
    383. 

  383. 			}
    384. 

  384. 			
    385. 

  385. 			function toggleTOC()
    386. 

  386. 			{
    387. 

  387. 				var contents = document.getElementById('contents');
    388. 

  388. 				var tocContainer = document.getElementById('tocContainer');
    389. 

  389. 				
    390. 

  390. 				if (this.getAttribute('class') == 'open')
    391. 

  391. 				{
    392. 

  392. 					this.setAttribute('class', '');
    393. 

  393. 					contents.setAttribute('class', '');
    394. 

  394. 					tocContainer.setAttribute('class', '');
    395. 

  395. 					
    396. 

  396. 					window.name = "hideTOC";
    397. 

  397. 				}
    398. 

  398. 				else
    399. 

  399. 				{
    400. 

  400. 					this.setAttribute('class', 'open');
    401. 

  401. 					contents.setAttribute('class', 'isShowingTOC');
    402. 

  402. 					tocContainer.setAttribute('class', 'isShowingTOC');
    403. 

  403. 					
    404. 

  404. 					window.name = "";
    405. 

  405. 				}
    406. 

  406. 				return false;
    407. 

  407. 			}
    408. 

  408. 			
    409. 

  409. 			function toggleTOCEntryChildren(e)
    410. 

  410. 			{
    411. 

  411. 				e.stopPropagation();
    412. 

  412. 				var currentClass = this.getAttribute('class');
    413. 

  413. 				if (currentClass == 'children') {
    414. 

  414. 					this.setAttribute('class', 'children open');
    415. 

  415. 				}
    416. 

  416. 				else if (currentClass == 'children open') {
    417. 

  417. 					this.setAttribute('class', 'children');
    418. 

  418. 				}
    419. 

  419. 				return false;
    420. 

  420. 			}
    421. 

  421. 			
    422. 

  422. 			function tocEntryClick(e)
    423. 

  423. 			{
    424. 

  424. 				e.stopPropagation();
    425. 

  425. 				return true;
    426. 

  426. 			}
    427. 

  427. 			
    428. 

  428. 			function init()
    429. 

  429. 			{
    430. 

  430. 				var selectElement = document.getElementById('jumpTo');
    431. 

  431. 				selectElement.addEventListener('change', jumpToChange, false);
    432. 

  432. 				
    433. 

  433. 				var tocButton = document.getElementById('table_of_contents');
    434. 

  434. 				tocButton.addEventListener('click', toggleTOC, false);
    435. 

  435. 				
    436. 

  436. 				var taskTreeItem = document.getElementById('task_treeitem');
    437. 

  437. 				if (taskTreeItem.getElementsByTagName('li').length > 0)
    438. 

  438. 				{
    439. 

  439. 					taskTreeItem.setAttribute('class', 'children');
    440. 

  440. 					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
    441. 

  441. 				}
    442. 

  442. 				
    443. 

  443. 				var tocList = document.getElementById('toc');
    444. 

  444. 				
    445. 

  445. 				var tocEntries = tocList.getElementsByTagName('li');
    446. 

  446. 				for (var i = 0; i < tocEntries.length; i++) {
    447. 

  447. 					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
    448. 

  448. 				}
    449. 

  449. 				
    450. 

  450. 				var tocLinks = tocList.getElementsByTagName('a');
    451. 

  451. 				for (var i = 0; i < tocLinks.length; i++) {
    452. 

  452. 					tocLinks[i].addEventListener('click', tocEntryClick, false);
    453. 

  453. 				}
    454. 

  454. 				
    455. 

  455. 				if (window.name == "hideTOC") {
    456. 

  456. 					toggleTOC.call(tocButton);
    457. 

  457. 				}
    458. 

  458. 			}
    459. 

  459. 			
    460. 

  460. 			window.onload = init;
    461. 

  461. 			
    462. 

  462. 			// If showing in Xcode, hide the TOC and Header
    463. 

  463. 			if (navigator.userAgent.match(/xcode/i)) {
    464. 

  464. 				document.getElementById("contents").className = "hideInXcode"
    465. 

  465. 				document.getElementById("tocContainer").className = "hideInXcode"
    466. 

  466. 				document.getElementById("top_header").className = "hideInXcode"
    467. 

  467. 			}
    468. 

  468. 			
    469. 

  469. 		</script>
    470. 

  470. 	</body>
    471. 

  471. </html>
    472.