solapi
Preparing search index...
services/kakao/channels/kakaoChannelService
default
Class default
Hierarchy (
View Summary
)
default
default
Index
Constructors
constructor
Methods
create
Kakao
Channel
get
Kakao
Channel
get
Kakao
Channel
Categories
get
Kakao
Channels
get
With
Query
remove
Kakao
Channel
request
request
Effect
request
Kakao
Channel
Token
Constructors
constructor
new
default
(
apiKey
:
string
,
apiSecret
:
string
)
:
default
Parameters
apiKey
:
string
apiSecret
:
string
Returns
default
Methods
create
Kakao
Channel
createKakaoChannel
(
data
:
{
categoryCode
:
string
;
phoneNumber
:
string
;
searchId
:
string
;
token
:
string
;
}
,
)
:
Promise
<
{
accountId
:
string
;
channelId
:
string
;
dateCreated
:
string
;
dateUpdated
:
string
;
phoneNumber
:
string
;
searchId
:
string
;
}
,
>
Parameters
data
:
{
categoryCode
:
string
;
phoneNumber
:
string
;
searchId
:
string
;
token
:
string
}
Returns
Promise
<
{
accountId
:
string
;
channelId
:
string
;
dateCreated
:
string
;
dateUpdated
:
string
;
phoneNumber
:
string
;
searchId
:
string
;
}
,
>
get
Kakao
Channel
getKakaoChannel
(
channelId
:
string
)
:
Promise
<
KakaoChannel
>
Parameters
channelId
:
string
Returns
Promise
<
KakaoChannel
>
get
Kakao
Channel
Categories
getKakaoChannelCategories
()
:
Promise
<
{
code
:
string
;
name
:
string
}
[]
>
Returns
Promise
<
{
code
:
string
;
name
:
string
}
[]
>
get
Kakao
Channels
getKakaoChannels
(
data
?:
{
categoryCode
?:
string
;
channelId
?:
string
;
endDate
?:
string
|
Date
;
isMine
?:
boolean
;
limit
?:
number
;
phoneNumber
?:
string
;
searchId
?:
string
;
startDate
?:
string
|
Date
;
startKey
?:
string
;
}
,
)
:
Promise
<
GetKakaoChannelsFinalizeResponse
>
Parameters
Optional
data
:
{
categoryCode
?:
string
;
channelId
?:
string
;
endDate
?:
string
|
Date
;
isMine
?:
boolean
;
limit
?:
number
;
phoneNumber
?:
string
;
searchId
?:
string
;
startDate
?:
string
|
Date
;
startKey
?:
string
;
}
Returns
Promise
<
GetKakaoChannelsFinalizeResponse
>
Protected
get
With
Query
getWithQuery
<
A
,
R
,
I
=
unknown
>
(
config
:
{
data
?:
unknown
;
finalize
:
(
validated
?:
A
)
=>
object
;
responseSchema
?:
Schema
<
R
,
I
,
never
>
;
schema
:
Schema
<
A
>
;
url
:
string
;
}
,
)
:
Effect
<
R
,
|
InvalidDateError
|
ApiKeyError
|
DefaultError
|
BadRequestError
|
NetworkError
|
ClientError
|
ResponseSchemaMismatchError
|
ServerError
,
>
Type Parameters
A
R
I
=
unknown
Parameters
config
:
{
data
?:
unknown
;
finalize
:
(
validated
?:
A
)
=>
object
;
responseSchema
?:
Schema
<
R
,
I
,
never
>
;
schema
:
Schema
<
A
>
;
url
:
string
;
}
Returns
Effect
<
R
,
|
InvalidDateError
|
ApiKeyError
|
DefaultError
|
BadRequestError
|
NetworkError
|
ClientError
|
ResponseSchemaMismatchError
|
ServerError
,
>
remove
Kakao
Channel
removeKakaoChannel
(
channelId
:
string
)
:
Promise
<
KakaoChannel
>
Parameters
channelId
:
string
Returns
Promise
<
KakaoChannel
>
Protected
request
request
<
T
,
R
,
I
=
unknown
>
(
parameter
:
DefaultServiceParameter
<
T
,
R
,
I
>
,
)
:
Promise
<
R
>
Type Parameters
T
R
I
=
unknown
Parameters
parameter
:
DefaultServiceParameter
<
T
,
R
,
I
>
Returns
Promise
<
R
>
Protected
request
Effect
requestEffect
<
T
,
R
,
I
=
unknown
>
(
parameter
:
DefaultServiceParameter
<
T
,
R
,
I
>
,
)
:
Effect
<
R
,
|
ApiKeyError
|
DefaultError
|
NetworkError
|
ClientError
|
ResponseSchemaMismatchError
|
ServerError
,
>
Type Parameters
T
R
I
=
unknown
Parameters
parameter
:
DefaultServiceParameter
<
T
,
R
,
I
>
Returns
Effect
<
R
,
|
ApiKeyError
|
DefaultError
|
NetworkError
|
ClientError
|
ResponseSchemaMismatchError
|
ServerError
,
>
request
Kakao
Channel
Token
requestKakaoChannelToken
(
data
:
{
phoneNumber
:
string
;
searchId
:
string
}
,
)
:
Promise
<
{
success
:
boolean
}
>
Parameters
data
:
{
phoneNumber
:
string
;
searchId
:
string
}
Returns
Promise
<
{
success
:
boolean
}
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
Kakao
Channel
get
Kakao
Channel
get
Kakao
Channel
Categories
get
Kakao
Channels
get
With
Query
remove
Kakao
Channel
request
request
Effect
request
Kakao
Channel
Token
solapi
Loading...