Add KaleyraVideoSDK doc for version 4.0.0

KaleyraVideoSDK/4.0.0/data/documentation/kaleyravideosdk/accesstokenprovider.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AccessTokenProvider","kind":"identifier"}]}]},{"kind":"content","content":[{"level":2,"anchor":"overview","text":"Overview","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The Kaleyra Video SDK adopts a strong authentication mechanism based on JWT access tokens."},{"type":"text","text":" "},{"text":"Whenever the SDK needs an access token for a particular user, this component will be asked to provide an access token for a particular user","type":"text"}]}]}],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK\/AccessTokenProvider\/provideAccessToken(userId:completion:)"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/kaleyravideosdk\/accesstokenprovider"]}],"metadata":{"externalID":"s:15KaleyraVideoSDK19AccessTokenProviderP","roleHeading":"Protocol","title":"AccessTokenProvider","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AccessTokenProvider"}],"symbolKind":"protocol","modules":[{"name":"KaleyraVideoSDK"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"AccessTokenProvider","kind":"identifier"}]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK\/AccessTokenProvider"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK"]]},"abstract":[{"text":"A component providing “access tokens” for a user.","type":"text"}],"references":{"doc://com.kaleyra.KaleyraVideoSDK/documentation/KaleyraVideoSDK":{"identifier":"doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK","title":"KaleyraVideoSDK","kind":"symbol","role":"collection","abstract":[],"type":"topic","url":"\/documentation\/kaleyravideosdk"},"doc://com.kaleyra.KaleyraVideoSDK/documentation/KaleyraVideoSDK/AccessTokenProvider":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"AccessTokenProvider","kind":"identifier"}],"type":"topic","role":"symbol","title":"AccessTokenProvider","url":"\/documentation\/kaleyravideosdk\/accesstokenprovider","identifier":"doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK\/AccessTokenProvider","kind":"symbol","abstract":[{"type":"text","text":"A component providing “access tokens” for a user."}],"navigatorTitle":[{"text":"AccessTokenProvider","kind":"identifier"}]},"doc://com.kaleyra.KaleyraVideoSDK/documentation/KaleyraVideoSDK/AccessTokenProvider/provideAccessToken(userId:completion:)":{"kind":"symbol","identifier":"doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK\/AccessTokenProvider\/provideAccessToken(userId:completion:)","type":"topic","required":true,"role":"symbol","abstract":[{"text":"The Kaleyra Video will call this method whenever an access token for the user identified by the ","type":"text"},{"type":"codeVoice","code":"userId"},{"text":" parameter is required","type":"text"}],"title":"provideAccessToken(userId:completion:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"provideAccessToken","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"completion"},{"kind":"text","text":": ("},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"url":"\/documentation\/kaleyravideosdk\/accesstokenprovider\/provideaccesstoken(userid:completion:)"}}}

KaleyraVideoSDK/4.0.0/data/documentation/kaleyravideosdk/accesstokenprovider/provideaccesstoken(userid:completion:).json

@@ -0,0 +1 @@
+{"abstract":[{"type":"text","text":"The Kaleyra Video will call this method whenever an access token for the user identified by the "},{"code":"userId","type":"codeVoice"},{"type":"text","text":" parameter is required"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"provideAccessToken","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"completion","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"text":"Result","kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":">) -> "},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"inlineContent":[{"text":"Once an access token is retrieved you should call the ","type":"text"},{"code":"completion","type":"codeVoice"},{"type":"text","text":" closure provided as second parameter"},{"type":"text","text":" "},{"text":"reporting a result for the operation.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This method may be invoked several times during the lifecycle of your app."}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"text":"userId: A value identifying the user in the Kaleyra Video platform","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"completion: The completion closure you must invoke when either your component has retrieved an access token successfully or your component could not retrieve the access token because of an error","type":"text"}],"type":"paragraph"}]}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK\/AccessTokenProvider\/provideAccessToken(userId:completion:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK","doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK\/AccessTokenProvider"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/kaleyravideosdk\/accesstokenprovider\/provideaccesstoken(userid:completion:)"]}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"provideAccessToken"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"completion"},{"text":": (","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO","text":"Result"},{"text":"<","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"role":"symbol","required":true,"roleHeading":"Instance Method","title":"provideAccessToken(userId:completion:)","externalID":"s:15KaleyraVideoSDK19AccessTokenProviderP07providedE06userId10completionySS_ys6ResultOySSs5Error_pGctF","modules":[{"name":"KaleyraVideoSDK"}],"symbolKind":"method"},"references":{"doc://com.kaleyra.KaleyraVideoSDK/documentation/KaleyraVideoSDK/AccessTokenProvider/provideAccessToken(userId:completion:)":{"kind":"symbol","identifier":"doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK\/AccessTokenProvider\/provideAccessToken(userId:completion:)","type":"topic","required":true,"role":"symbol","abstract":[{"text":"The Kaleyra Video will call this method whenever an access token for the user identified by the ","type":"text"},{"type":"codeVoice","code":"userId"},{"text":" parameter is required","type":"text"}],"title":"provideAccessToken(userId:completion:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"provideAccessToken","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"completion"},{"kind":"text","text":": ("},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"url":"\/documentation\/kaleyravideosdk\/accesstokenprovider\/provideaccesstoken(userid:completion:)"},"doc://com.kaleyra.KaleyraVideoSDK/documentation/KaleyraVideoSDK":{"identifier":"doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK","title":"KaleyraVideoSDK","kind":"symbol","role":"collection","abstract":[],"type":"topic","url":"\/documentation\/kaleyravideosdk"},"doc://com.kaleyra.KaleyraVideoSDK/documentation/KaleyraVideoSDK/AccessTokenProvider":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"AccessTokenProvider","kind":"identifier"}],"type":"topic","role":"symbol","title":"AccessTokenProvider","url":"\/documentation\/kaleyravideosdk\/accesstokenprovider","identifier":"doc:\/\/com.kaleyra.KaleyraVideoSDK\/documentation\/KaleyraVideoSDK\/AccessTokenProvider","kind":"symbol","abstract":[{"type":"text","text":"A component providing “access tokens” for a user."}],"navigatorTitle":[{"text":"AccessTokenProvider","kind":"identifier"}]}}}