基于IOSSSOSDK文档.docxVIP

IOS SSO SDK文档北京新潮讯捷信息技术有限公司编号：WEIBO_IOS_SSO_SDK版本：WEIBO_IOS_SSO_SDK V1.0.0修订记录时间文档版本修订人备注2012/7/191.0.0陈行政初稿概述微博SDK为开发者提供访问微博api的集成接口，将身份验证以及api调用集成起来。并集成sso登录功能，使第三方应用可通过新浪微博官方客户端快速通过Oauth2.0授权，并完成用户登录操作。本文档将对使用IOS SDK时所用的一些参数、接口进行说明，并分析一个简单示例，帮助第三方更方便的使用SDK（一些不使用的接口只做简单说明）。名词解释AppKey分配给每个第三方应用的app key。用于鉴权身份，显示来源等功能。APPSecret生成请求request Token的secret，与app key一起分配。AccessToken表示用户身份的token，用于微博API的调用。ExpirationDate过期时间，用于判断登录是否过期。RedirectURI应用回调页面，可在新浪微博开放平台-我的应用-应用信息-高级应用-授权设置-应用回调页中找到。ssoCallbackSchemesso回调地址，info.plist中定义的URL types，用于在微博客户端完成sso登录后进行回调。流程使用带sso功能的sdk进行登录，只需调用登录接口，并完成回调方法对接收登录结果即可。SDK中自动完成对是否进行SSO登录的判断，若支持，则唤起微博客户端，用户确认后返回请求的应用，SDK对请求结果进行解析，最后交给第三方实现的回调方法进行处理；否则，SDK将通过内置浏览器请求登录，用户输入用户名密码提交后，仍是SDK解析请求结果，并由第三方应用实现相应的回调方法进行最后处理。接口说明SinaWeiboSinaWeibo作为提供给第三方应用的主要接口，提供登录，登出，以及访问微博api的功能。用户在使用sdk前需实现唯一的SinaWeibo对象，将在之后的一系列操作中用到。方法(id)initWithAppKey:(NSString*)_appKeyappSecret:(NSString *)_appSecrectappRedirectURI:(NSString *)_appRedirectURIandDelegate:(idSinaWeiboDelegate)_delegate简介初始化方法，构造一个SinaWeibo对象。此构造方法没有传入sso回调地址，适用于采用默认sso回调地址的第三方应用。参数作用_appKey分配给第三方应用的app key_appSecrect分配给第三方应用的app secret_appRedirectURI应用回调页_delegate第三方应用实现的SinaWeiboDelegate协议对象，用来处理登录及登出结果返回类型SinaWeibo:构造函数返回当前实现的对象，在第三方应用中调用此对象进行登入登出等操作方法(id)initWithAppKey:(NSString *)_appKeyappSecret:(NSString *)_appSecrectappRedirectURI:(NSString *)_appRedirectURIssoCallbackScheme:(NSString *)_ssoCallbackSchemeandDelegate:(idSinaWeiboDelegate)_delegate简介初始化方法，构造一个SinaWeibo对象。此构造方法传入自定义的sso回调地址。参数作用_appKey分配给第三方应用的app key_appSecrect分配给第三方应用的app secret_appRedirectURI应用回调页_ssoCallbackScheme自定义的sso回调地址，在info.plist中的URL Types所定义的。_delegate第三方应用实现的SinaWeiboDelegate协议对象，用来处理登录及登出结果返回类型SinaWeibo:构造函数返回当前实现的对象，在第三方应用中调用此对象进行登入登出等操作方法- (void)logIn简介登录操作，直接调用。SinaWeibo对象根据具体环境进行sso登录或是浏览器登录，接收到登录结果后解析，并通过构造时传入的SinaWeiboDelegate对象调用sinaweiboDidLogIn方法将登录结果返回给应用。参数作用无无返回类型无方法- (void)logOut简介登出操作，直接调用。在接收到登出结果后解析，并通过构造时传入的SinaWeiboDelegate对象调用sinaweiboDidLogOut方法将登出结果返回给应用。参数作用无无返回类型无方法(BOOL)isLoggedIn简介