Add KaleyraVideoSDK code doc

KaleyraVideoSDK/4.0.0-alpha.1/data/documentation/kaleyravideosdk/accesstokenprovider.json

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

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

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