net.daum.dna.api
Interface YozmAPI

All Known Implementing Classes:
DefaultYozmAPI

public interface YozmAPI

The Interface YozmAPI. writeArticle method option 종류 : - message : 보낼 Message - url_shorten : Message 에 포함된 URL 을 줄일 수 있다. - img_url : 첨부할 이미지의 URL - parent_msg_id : 반응글로 작성시 원본글의 Message ID getUserInfo method option 종류 : - url_name : 인기 리스트를 보고 싶은 사용자의 ID (Oauth 인증 실패시 url_name 으로 수행) - nick_name : 인기 리스트를 보고 싶은 사용자의 별명 ( url_name 으로 수행 실패시 nick_name 으로 수행).


Method Summary
 YozmUserJoined checkUserJoin()
          현재 oauth 인증된 사용자의 Yozm 가입 여부를 return 한다 오류 발생시 NULL 반환.
 java.lang.String checkUserJoinAsJSON()
          현재 oauth 인증된 사용자의 Yozm 가입 여부를 return 한다
 java.lang.String checkUserJoinAsXML()
          현재 oauth 인증된 사용자의 Yozm 가입 여부를 return 한다
 YozmArticles getArticles()
          모든 글 List 를 가지고 온다.
 YozmArticles getArticles(Params option)
          모든 글 List 를 가지고 온다.
 java.lang.String getArticlesAsJSON()
          모든 글 List 를 가지고 온다.
 java.lang.String getArticlesAsJSON(Params option)
          모든 글 List 를 가지고 온다.
 java.lang.String getArticlesAsXML()
          모든 글 List 를 가지고 온다.
 java.lang.String getArticlesXML(Params option)
          모든 글 List 를 가지고 온다.
 java.util.List<YozmUserArticles> getUserArticles()
          특정 사용자의 글 목록을 가져온다.
 java.util.List<YozmUserArticles> getUserArticles(Params option)
          특정 사용자의 글 목록을 가져온다.
 java.lang.String getUserArticlesAsJSON()
          특정 사용자의 글 목록을 가져온다.
 java.lang.String getUserArticlesAsJSON(Params option)
          특정 사용자의 글 목록을 가져온다.
 java.lang.String getUserArticlesAsXML()
          특정 사용자의 글 목록을 가져온다.
 java.lang.String getUserArticlesAsXML(Params option)
          특정 사용자의 글 목록을 가져온다.
 YozmUserInfo getUserInfo()
          사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.
 YozmUserInfo getUserInfo(Params option)
          사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.
 java.lang.String getUserInfoAsJSON()
          사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.
 java.lang.String getUserInfoAsJSON(Params option)
          사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.
 java.lang.String getUserInfoAsXML()
          사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.
 java.lang.String getUserInfoAsXML(Params option)
          사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.
 YozmUserJoin joinYozm(java.lang.String nickname)
          Yozm 에 가입하는 기능을 제공한다.
 YozmUserJoin joinYozm(java.lang.String nickname, Params option)
          Yozm 에 가입하는 기능을 제공한다.
 java.lang.String joinYozmAsJSON(java.lang.String nickname)
          Yozm 에 가입하는 기능을 제공한다.
 java.lang.String joinYozmAsJSON(java.lang.String nickname, Params option)
          Yozm 에 가입하는 기능을 제공한다.
 java.lang.String joinYozmAsXML(java.lang.String nickname)
          Yozm 에 가입하는 기능을 제공한다.
 java.lang.String joinYozmAsXML(java.lang.String nickname, Params option)
          Yozm 에 가입하는 기능을 제공한다.
 YozmArticles searchArticles(java.lang.String q)
          글을 검색하는 기능 오류 발생시 null 반환.
 YozmArticles searchArticles(java.lang.String q, Params option)
          글을 검색하는 기능
 java.lang.String searchArticlesAsJSON(java.lang.String q)
          글을 검색하는 기능
 java.lang.String searchArticlesAsJSON(java.lang.String q, Params option)
          글을 검색하는 기능
 java.lang.String searchArticlesAsXML(java.lang.String q)
          글을 검색하는 기능
 java.lang.String searchArticlesAsXML(java.lang.String q, Params option)
          글을 검색하는 기능
 YozmWriteRes writeArticle(java.lang.String message)
          Yozm 에 자신의 글을 등록 한다.
 YozmWriteRes writeArticle(java.lang.String message, Params option)
          Yozm 에 자신의 글을 등록 한다.
 java.lang.String writeArticleAsJSON(java.lang.String message)
          Yozm 에 자신의 글을 등록 한다.
 java.lang.String writeArticleAsJSON(java.lang.String message, Params option)
          Yozm 에 자신의 글을 등록 한다.
 java.lang.String writeArticleAsXML(java.lang.String message)
          Yozm 에 자신의 글을 등록 한다.
 java.lang.String writeArticleAsXML(java.lang.String message, Params option)
          Yozm 에 자신의 글을 등록 한다.
 

Method Detail

checkUserJoin

YozmUserJoined checkUserJoin()
현재 oauth 인증된 사용자의 Yozm 가입 여부를 return 한다 오류 발생시 NULL 반환.

Returns:
가입여부를 객체 형태 또는 NULL 반환.

checkUserJoinAsXML

java.lang.String checkUserJoinAsXML()
현재 oauth 인증된 사용자의 Yozm 가입 여부를 return 한다

Returns:
가입여부를 XML String 형태로 반환.

checkUserJoinAsJSON

java.lang.String checkUserJoinAsJSON()
현재 oauth 인증된 사용자의 Yozm 가입 여부를 return 한다

Returns:
가입여부를 JSON String 형태로 반환.

joinYozm

YozmUserJoin joinYozm(java.lang.String nickname)
Yozm 에 가입하는 기능을 제공한다. 오류 발생시 null 반환.

Parameters:
nickname - Yozm 에서 사용할 닉네임
Returns:
가입 결과를 객체 형태 또는 null 로 반환.

joinYozm

YozmUserJoin joinYozm(java.lang.String nickname,
                      Params option)
Yozm 에 가입하는 기능을 제공한다. 오류 발생시 null 반환.

Parameters:
nickname - Yozm 에서 사용할 닉네임
option - - sex : 성별 ( N : 비공개 , F : 여자 , M : 남자); - birthday : 생일 (string , YYYY-MM-DD) - blood_type : 혈액형 (N : 비공개 , A , B , AB ,O );
Returns:
가입 결과를 객체 형태 또는 NULL 로 반환.

joinYozmAsXML

java.lang.String joinYozmAsXML(java.lang.String nickname)
Yozm 에 가입하는 기능을 제공한다.

Parameters:
nickname - Yozm 에서 사용할 닉네임
Returns:
가입 결과를 XML String 형태로 반환.

joinYozmAsXML

java.lang.String joinYozmAsXML(java.lang.String nickname,
                               Params option)
Yozm 에 가입하는 기능을 제공한다.

Parameters:
nickname - Yozm 에서 사용할 닉네임
option - - sex : 성별 ( N : 비공개 , F : 여자 , M : 남자); - birthday : 생일 (string , YYYY-MM-DD) - blood_type : 혈액형 (N : 비공개 , A , B , AB ,O );
Returns:
가입 결과를 XML String 형태로 반환.

joinYozmAsJSON

java.lang.String joinYozmAsJSON(java.lang.String nickname)
Yozm 에 가입하는 기능을 제공한다.

Parameters:
nickname - Yozm 에서 사용할 닉네임
Returns:
가입 결과를 JSON String 형태로 반환.

joinYozmAsJSON

java.lang.String joinYozmAsJSON(java.lang.String nickname,
                                Params option)
Yozm 에 가입하는 기능을 제공한다.

Parameters:
nickname - Yozm 에서 사용할 닉네임
option - - sex : 성별 ( N : 비공개 , F : 여자 , M : 남자); - birthday : 생일 (string , YYYY-MM-DD) - blood_type : 혈액형 (N : 비공개 , A , B , AB ,O );
Returns:
가입 결과를 JSON String 형태로 반환.

searchArticles

YozmArticles searchArticles(java.lang.String q)
글을 검색하는 기능 오류 발생시 null 반환.

Parameters:
q - 검색어
Returns:
결과 글 목록을 객체 형태 또는 null 반환.

searchArticles

YozmArticles searchArticles(java.lang.String q,
                            Params option)
글을 검색하는 기능

Parameters:
q - 검색어
option - - type : 검색 종류 (message or tag) - page : 페이지 (int) - count : 페이지 크기 (1~30)
Returns:
결과 글 목록을 객체 형태 또는 null 반환.

searchArticlesAsXML

java.lang.String searchArticlesAsXML(java.lang.String q)
글을 검색하는 기능

Parameters:
q - 검색어
Returns:
결과 글 목록을 XML String 형태로 반환.

searchArticlesAsXML

java.lang.String searchArticlesAsXML(java.lang.String q,
                                     Params option)
글을 검색하는 기능

Parameters:
q - 검색어
option - - type : 검색 종류 (message or tag) - page : 페이지 (int) - count : 페이지 크기 (1~30)
Returns:
결과 글 목록을 XML String 형태로 반환.

searchArticlesAsJSON

java.lang.String searchArticlesAsJSON(java.lang.String q)
글을 검색하는 기능

Parameters:
q - 검색어
Returns:
결과 글 목록을 JSON String 형태로 반환.

searchArticlesAsJSON

java.lang.String searchArticlesAsJSON(java.lang.String q,
                                      Params option)
글을 검색하는 기능

Parameters:
q - 검색어
option - - type : 검색 종류 (message or tag) - page : 페이지 (int) - count : 페이지 크기 (1~30)
Returns:
결과 글 목록을 JSON String 형태로 반환.

writeArticle

YozmWriteRes writeArticle(java.lang.String message)
Yozm 에 자신의 글을 등록 한다. 오류 발생시 null 반환.

Parameters:
message - 보낼 Message
Returns:
등록된 글 정보를 객체 형태 또는 null 반환.

writeArticle

YozmWriteRes writeArticle(java.lang.String message,
                          Params option)
Yozm 에 자신의 글을 등록 한다. 오류 발생시 null 반환.

Parameters:
message - 보낼 Message
option - - url_shorten : url_shorten 서비스를 이용해 url 을 줄임 (String) - img_url : 첨부할 이미지 주소 (String) - parent_msg_id : reply 로 달리게 될 글의 msg id (int)
Returns:
등록된 글 정보를 객체 형태 또는 null 반환.

writeArticleAsXML

java.lang.String writeArticleAsXML(java.lang.String message)
Yozm 에 자신의 글을 등록 한다.

Parameters:
message - 보낼 Message
Returns:
등록된 글 정보를 XML String 형태로 반환.

writeArticleAsXML

java.lang.String writeArticleAsXML(java.lang.String message,
                                   Params option)
Yozm 에 자신의 글을 등록 한다.

Parameters:
message - 보낼 Message
option - - url_shorten : url_shorten 서비스를 이용해 url 을 줄임 (String) - img_url : 첨부할 이미지 주소 (String) - parent_msg_id : reply 로 달리게 될 글의 msg id (int)
Returns:
등록된 글 정보를 XML String 형태로 반환.

writeArticleAsJSON

java.lang.String writeArticleAsJSON(java.lang.String message)
Yozm 에 자신의 글을 등록 한다.

Parameters:
message - 보낼 Message
Returns:
등록된 글 정보를 JSON String 형태로 반환.

writeArticleAsJSON

java.lang.String writeArticleAsJSON(java.lang.String message,
                                    Params option)
Yozm 에 자신의 글을 등록 한다.

Parameters:
message - 보낼 Message
option - - url_shorten : url_shorten 서비스를 이용해 url 을 줄임 (String) - img_url : 첨부할 이미지 주소 (String) - parent_msg_id : reply 로 달리게 될 글의 msg id (int)
Returns:
등록된 글 정보를 JSON String 형태로 반환.

getArticles

YozmArticles getArticles()
모든 글 List 를 가지고 온다. 오류 발생시 null 반환.

Returns:
글 목록을 객체 형태 또는 NULL 반환.

getArticles

YozmArticles getArticles(Params option)
모든 글 List 를 가지고 온다. 오류 발생시 NULL 반환.

Parameters:
option - - max_msg_id : 주어진 id 보다 작은 message를 가져온다. (int) - since_msg_id : 주어진 id 보다 큰 message 를 가져온다. (int) - count : 가져올 message의 수 (int)
Returns:
글 목록을 객체 형태 또는 NULL 반환.

getArticlesAsXML

java.lang.String getArticlesAsXML()
모든 글 List 를 가지고 온다.

Returns:
글목록을 XML String 형태로 반환.

getArticlesXML

java.lang.String getArticlesXML(Params option)
모든 글 List 를 가지고 온다.

Parameters:
option - - max_msg_id : 주어진 id 보다 작은 message를 가져온다. (int) - since_msg_id : 주어진 id 보다 큰 message 를 가져온다. (int) - count : 가져올 message의 수 (int)
Returns:
글 목록을 XML String 형태로 반환.

getArticlesAsJSON

java.lang.String getArticlesAsJSON()
모든 글 List 를 가지고 온다.

Returns:
글 목록을 JSON String 형태로 반환.

getArticlesAsJSON

java.lang.String getArticlesAsJSON(Params option)
모든 글 List 를 가지고 온다.

Parameters:
option - - max_msg_id : 주어진 id 보다 작은 message를 가져온다. (int) - since_msg_id : 주어진 id 보다 큰 message 를 가져온다. (int) - count : 가져올 message의 수 (int)
Returns:
글 목록을 JSON String 형태로 반환.

getUserInfo

YozmUserInfo getUserInfo()
사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다. 오류 발생시 null 반환.

Returns:
사용자 정보를 객체 형태 또는 null 반환.

getUserInfo

YozmUserInfo getUserInfo(Params option)
사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다. 오류 발생 시 null 반환.

Parameters:
option - - url_name : 인기 리스트를 보고 싶은 사용자의 id ( string) - nick_name : 인기 리스트를 보고 싶은 사용자의 요즘 nickName (string)
Returns:
사용자 정보를 객체 형태 또는 null 반환.

getUserInfoAsXML

java.lang.String getUserInfoAsXML()
사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.

Returns:
사용자 정보를 XML String 형태로 반환.

getUserInfoAsXML

java.lang.String getUserInfoAsXML(Params option)
사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.

Parameters:
option - - url_name : 인기 리스트를 보고 싶은 사용자의 id ( string) - nick_name : 인기 리스트를 보고 싶은 사용자의 요즘 nickName (string)
Returns:
사용자 정보를 XML String 형태로 반환.

getUserInfoAsJSON

java.lang.String getUserInfoAsJSON()
사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.

Returns:
사용자 정보를 JSON String 형태로 반환.

getUserInfoAsJSON

java.lang.String getUserInfoAsJSON(Params option)
사용자의 정보를 보여주는 Method option 없을 시에는 자기 자신의 정보를 보여준다.

Parameters:
option - - url_name : 인기 리스트를 보고 싶은 사용자의 id ( string) - nick_name : 인기 리스트를 보고 싶은 사용자의 요즘 nickName (string)
Returns:
사용자 정보를 JSON String 형태로 반환.

getUserArticles

java.util.List<YozmUserArticles> getUserArticles()
특정 사용자의 글 목록을 가져온다. 오류 발생시 null 반환.

Returns:
글 목록을 객체 형태 또는 null 반환.

getUserArticles

java.util.List<YozmUserArticles> getUserArticles(Params option)
특정 사용자의 글 목록을 가져온다. 오류 발생시 null 반환.

Parameters:
option - - url_name : DaumID (String) - next : 주어진 id 보다 최신의 message 반환 (int) - count : 가져올 message 의 수 (int)
Returns:
글 목록을 객체 형태 또는 null 반환.

getUserArticlesAsXML

java.lang.String getUserArticlesAsXML()
특정 사용자의 글 목록을 가져온다.

Returns:
글 목록을 XML String 형태로 반환.

getUserArticlesAsXML

java.lang.String getUserArticlesAsXML(Params option)
특정 사용자의 글 목록을 가져온다.

Parameters:
option - - url_name : DaumID (String) - next : 주어진 id 보다 최신의 message 반환 (int) - count : 가져올 message 의 수 (int)
Returns:
글 목록을 XML String 형태로 반환.

getUserArticlesAsJSON

java.lang.String getUserArticlesAsJSON()
특정 사용자의 글 목록을 가져온다.

Returns:
글 목록을 JSON String 형태로 반환.

getUserArticlesAsJSON

java.lang.String getUserArticlesAsJSON(Params option)
특정 사용자의 글 목록을 가져온다.

Parameters:
option - - url_name : DaumID (String) - next : 주어진 id 보다 최신의 message 반환 (int) - count : 가져올 message 의 수 (int)
Returns:
글 목록을 JSON String 형태로 반환.