From 6f50c9b99170a28e67c3e375dcb26171cc2ab46b Mon Sep 17 00:00:00 2001 From: cometj03 <48352078+cometj03@users.noreply.github.com> Date: Mon, 26 Feb 2024 07:46:07 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-page=20from=20=20@=2028d4ba?= =?UTF-8?q?71b505f4922ddd9dcf1230ddf99f3ba11c=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../-log-list-request/-log-list-request.html | 80 ++++ .../-log-list-request/event-list.html | 80 ++++ .../-log-list-request}/index.html | 26 +- .../-log-list-response.html} | 10 +- .../-log-list-response/index.html | 138 +++++++ .../-log-list-response/result.html | 80 ++++ .../-log-list-response/success.html | 80 ++++ .../-logging-request/-logging-request.html | 80 ++++ .../-logging-request/event.html | 80 ++++ .../-logging-request/hashed-id.html | 80 ++++ .../-logging-request/index.html | 153 ++++++++ .../-logging-request/timestamp.html | 80 ++++ .../-logging-response/-logging-response.html} | 10 +- .../-logging-response/index.html | 138 +++++++ .../-logging-response/result.html | 80 ++++ .../-logging-response/success.html | 80 ++++ .../-logging-service}/index.html | 31 +- .../-logging-service/put-log-list.html | 80 ++++ .../-logging-service}/put-log.html | 6 +- .../index.html | 197 ++++++++++ .../to-log-list-request.html | 80 ++++ .../to-logging-request.html | 80 ++++ .../-hash-util/index.html | 104 ----- .../-y-l-s-event-data/-y-l-s-event-data.html | 4 +- .../-y-l-s-event-data/event.html | 2 +- .../{hashed-i-d.html => hashed-id.html} | 10 +- .../-y-l-s-event-data/index.html | 56 ++- .../-y-l-s-event-data/timestamp.html | 2 +- .../-y-l-s-event-data/version.html} | 10 +- .../-y-l-s/-companion/index.html | 164 -------- .../-y-l-s/-facade/create-log.html | 80 ++++ .../-y-l-s/{-companion => -facade}/flush.html | 6 +- .../generate-random-id.html | 4 +- .../get-timestamp.html} | 10 +- .../-y-l-s/-facade/hash-string.html | 80 ++++ .../-y-l-s/-facade/index.html | 359 ++++++++++++++++++ .../-y-l-s/{-companion => -facade}/init.html | 6 +- .../-y-l-s/{-companion => -facade}/log.html | 6 +- .../-y-l-s/-facade/set-default-event.html | 80 ++++ .../-y-l-s/-facade/set-logger.html | 80 ++++ .../-y-l-s/-facade/set-user-id.html | 80 ++++ .../-y-l-s/-facade/version.html | 80 ++++ .../-y-l-s/-logger/index.html | 2 +- .../-y-l-s/-remote-logger/index.html | 2 +- .../-y-l-s/index.html | 20 +- .../com.yourssu.logging.system/index.html | 107 +++++- .../log-app-init.html | 80 ++++ .../com.yourssu.logging.system/log-click.html | 80 ++++ .../log-deep-link-entry.html | 80 ++++ .../com.yourssu.logging.system/log-event.html | 80 ++++ .../log-screen-entry.html} | 48 +-- .../log-screen-exit.html | 80 ++++ docs/0.x/-y-l-s--android/package-list | 62 ++- docs/0.x/index.html | 6 +- docs/0.x/navigation.html | 64 +++- docs/0.x/scripts/pages.json | 2 +- 56 files changed, 3235 insertions(+), 450 deletions(-) create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/-log-list-request.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/event-list.html rename docs/0.x/-y-l-s--android/{com.yourssu.logging.system.worker/-y-l-s-response => com.yourssu.logging.system.remote/-log-list-request}/index.html (67%) rename docs/0.x/-y-l-s--android/{com.yourssu.logging.system/-hash-util/hash-id.html => com.yourssu.logging.system.remote/-log-list-response/-log-list-response.html} (79%) create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-response/index.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-response/result.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-response/success.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-request/-logging-request.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-request/event.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-request/hashed-id.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-request/index.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-request/timestamp.html rename docs/0.x/-y-l-s--android/{com.yourssu.logging.system.worker/-y-l-s-response/-y-l-s-response.html => com.yourssu.logging.system.remote/-logging-response/-logging-response.html} (82%) create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-response/index.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-response/result.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-response/success.html rename docs/0.x/-y-l-s--android/{com.yourssu.logging.system.worker/-http-service => com.yourssu.logging.system.remote/-logging-service}/index.html (57%) create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-service/put-log-list.html rename docs/0.x/-y-l-s--android/{com.yourssu.logging.system.worker/-http-service => com.yourssu.logging.system.remote/-logging-service}/put-log.html (76%) create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/index.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/to-log-list-request.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/to-logging-request.html delete mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-hash-util/index.html rename docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s-event-data/{hashed-i-d.html => hashed-id.html} (84%) rename docs/0.x/-y-l-s--android/{com.yourssu.logging.system.worker/-y-l-s-response/a.html => com.yourssu.logging.system/-y-l-s-event-data/version.html} (87%) delete mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-companion/index.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/create-log.html rename docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/{-companion => -facade}/flush.html (87%) rename docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/{-companion => -facade}/generate-random-id.html (95%) rename docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/{-companion/get-timestamp-i-s-o8601.html => -facade/get-timestamp.html} (81%) create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/hash-string.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/index.html rename docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/{-companion => -facade}/init.html (70%) rename docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/{-companion => -facade}/log.html (89%) create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/set-default-event.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/set-logger.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/set-user-id.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/version.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/log-app-init.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/log-click.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/log-deep-link-entry.html create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/log-event.html rename docs/0.x/-y-l-s--android/{com.yourssu.logging.system.worker/index.html => com.yourssu.logging.system/log-screen-entry.html} (51%) create mode 100644 docs/0.x/-y-l-s--android/com.yourssu.logging.system/log-screen-exit.html diff --git a/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/-log-list-request.html b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/-log-list-request.html new file mode 100644 index 0000000..9983494 --- /dev/null +++ b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/-log-list-request.html @@ -0,0 +1,80 @@ + + + + + LogListRequest + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

LogListRequest

+
+
constructor(eventList: List<LoggingRequest>)
+
+ +
+
+
+ + diff --git a/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/event-list.html b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/event-list.html new file mode 100644 index 0000000..503b7fb --- /dev/null +++ b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/event-list.html @@ -0,0 +1,80 @@ + + + + + eventList + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

eventList

+
+
@SerializedName(value = "logRequestList")
val eventList: List<LoggingRequest>
+
+ +
+
+
+ + diff --git a/docs/0.x/-y-l-s--android/com.yourssu.logging.system.worker/-y-l-s-response/index.html b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/index.html similarity index 67% rename from docs/0.x/-y-l-s--android/com.yourssu.logging.system.worker/-y-l-s-response/index.html rename to docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/index.html index a96c4b9..f3f8421 100644 --- a/docs/0.x/-y-l-s--android/com.yourssu.logging.system.worker/-y-l-s-response/index.html +++ b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-request/index.html @@ -2,7 +2,7 @@ - YLSResponse + LogListRequest @@ -61,28 +61,28 @@
-
- +
+
-

YLSResponse

-
data class YLSResponse(val a: String)
+

LogListRequest

+
data class LogListRequest(val eventList: List<LoggingRequest>)

Constructors

-
+
- - + +
Link copied to clipboard
-
constructor(a: String)
+
constructor(eventList: List<LoggingRequest>)
@@ -91,17 +91,17 @@

Constructors

Properties

-
+
- - + +
Link copied to clipboard
-
val a: String
+
@SerializedName(value = "logRequestList")
val eventList: List<LoggingRequest>
diff --git a/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-hash-util/hash-id.html b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-response/-log-list-response.html similarity index 79% rename from docs/0.x/-y-l-s--android/com.yourssu.logging.system/-hash-util/hash-id.html rename to docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-response/-log-list-response.html index b0b9b9b..3ad51ce 100644 --- a/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-hash-util/hash-id.html +++ b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-log-list-response/-log-list-response.html @@ -2,7 +2,7 @@ - hashId + LogListResponse @@ -61,12 +61,12 @@
-
- +
+
-

hashId

+

LogListResponse

-
fun hashId(id: String): String
+
constructor(success: Boolean, result: LogListRequest)
-
- +
+
-

YLSResponse

+

LoggingResponse

-
constructor(a: String)
+
constructor(success: Boolean, result: LoggingRequest)
-
- +
+
-

HttpService

-
interface HttpService
+

LoggingService

+
interface LoggingService

Functions

-
+
- +
Link copied to clipboard
-
@PUT(value = "/")
abstract suspend fun putLog(@Body eventData: YLSEventData): Response<YLSResponse>
+
@PUT(value = "/log")
abstract suspend fun putLog(@Body request: LoggingRequest): Response<LoggingResponse>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@PUT(value = "/log/list")
abstract suspend fun putLogList(@Body request: LogListRequest): Response<LogListResponse>
diff --git a/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-service/put-log-list.html b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-service/put-log-list.html new file mode 100644 index 0000000..86136b9 --- /dev/null +++ b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-service/put-log-list.html @@ -0,0 +1,80 @@ + + + + + putLogList + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

putLogList

+
+
@PUT(value = "/log/list")
abstract suspend fun putLogList(@Body request: LogListRequest): Response<LogListResponse>
+
+ +
+
+
+ + diff --git a/docs/0.x/-y-l-s--android/com.yourssu.logging.system.worker/-http-service/put-log.html b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-service/put-log.html similarity index 76% rename from docs/0.x/-y-l-s--android/com.yourssu.logging.system.worker/-http-service/put-log.html rename to docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-service/put-log.html index f6f08e6..e4517db 100644 --- a/docs/0.x/-y-l-s--android/com.yourssu.logging.system.worker/-http-service/put-log.html +++ b/docs/0.x/-y-l-s--android/com.yourssu.logging.system.remote/-logging-service/put-log.html @@ -61,12 +61,12 @@
-
- +
+

putLog

-
@PUT(value = "/")
abstract suspend fun putLog(@Body eventData: YLSEventData): Response<YLSResponse>
+
@PUT(value = "/log")
abstract suspend fun putLog(@Body request: LoggingRequest): Response<LoggingResponse>
-
+

YLSEventData

-
constructor(hashedID: String, timestamp: String, event: Map<String, Any>)

Parameters

hashedID

암호화 된 ID. 이벤트 식별을 위해 필요

timestamp

이벤트 데이터가 생성된 시간. ISO 8601 포맷

event

key-value 쌍의 상세한 이벤트 정보

+
constructor(hashedId: String, timestamp: String, version: Int, event: Map<String, Any>)
-

Parameters

event

key-value 쌍의 상세한 이벤트 정보

+
-
- +
+
-

hashedID

+

hashedId

-

Parameters

hashedID

암호화 된 ID. 이벤트 식별을 위해 필요

+

YLSEventData

-
data class YLSEventData(val hashedID: String, val timestamp: String, val event: Map<String, Any>)

YLS에서 사용되는 기본 이벤트 데이터

Parameters

hashedID

암호화 된 ID. 이벤트 식별을 위해 필요

timestamp

이벤트 데이터가 생성된 시간. ISO 8601 포맷

event

key-value 쌍의 상세한 이벤트 정보

+
data class YLSEventData(val hashedId: String, val timestamp: String, val version: Int, val event: Map<String, Any>)

YLS에서 사용되는 기본 이벤트 데이터

-
+

Constructors

-
+
- +
Link copied to clipboard
-
constructor(hashedID: String, timestamp: String, event: Map<String, Any>)
+
constructor(hashedId: String, timestamp: String, version: Int, event: Map<String, Any>)
@@ -101,22 +101,22 @@

Properties

- +

key-value 쌍의 상세한 이벤트 정보

- +
- - + +
Link copied to clipboard
- +

암호화 된 ID. 이벤트 식별을 위해 필요

@@ -131,7 +131,41 @@

Properties

- +

이벤트 데이터가 생성된 시간. ISO 8601 포맷

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
diff --git a/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s-event-data/timestamp.html b/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s-event-data/timestamp.html index bed04a1..b786b2a 100644 --- a/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s-event-data/timestamp.html +++ b/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s-event-data/timestamp.html @@ -66,7 +66,7 @@

timestamp

-

Parameters

timestamp

이벤트 데이터가 생성된 시간. ISO 8601 포맷

+
-
- +
+
-

a

+

version

-
val a: String
+
-
- +
+

flush

-
fun flush()

Logger에 남아있는 로그 데이터를 모두 내보낸 후 큐를 비웁니다.

+
open override fun flush()

Logger에 남아있는 로그 데이터를 모두 내보낸 후 큐를 비웁니다.

-
- +
+

generateRandomId

diff --git a/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-companion/get-timestamp-i-s-o8601.html b/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/get-timestamp.html similarity index 81% rename from docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-companion/get-timestamp-i-s-o8601.html rename to docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/get-timestamp.html index 2ff7920..9e2ef86 100644 --- a/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-companion/get-timestamp-i-s-o8601.html +++ b/docs/0.x/-y-l-s--android/com.yourssu.logging.system/-y-l-s/-facade/get-timestamp.html @@ -2,7 +2,7 @@ - getTimestampISO8601 + getTimestamp @@ -61,12 +61,12 @@
-
- +
+
-

getTimestampISO8601

+

getTimestamp

-

현재 시각을 ISO 8601 포맷의 문자열을 반환합니다.

Return

ISO 8601 format string of current

+

현재 시각을 ISO 8601 포맷의 문자열을 반환합니다.

Return

ISO 8601 format string of current

-
- +
+

init

-
fun init(platform: String, user: String, logger: YLS.Logger)

최초 YLS 초기화. 앱의 Application.onCreate()에서 초기화하는 것을 권장합니다.

Parameters

platform

플랫폼 이름

user

유저 ID. 비로그인 상태라면 YLS.generateRandomId로 임시 ID 생성 권장

logger

실질적인 로깅 객체. YLS.Logger의 서브 타입

+
fun init(platform: String, userId: String, logger: YLS.Logger)

YLS 초기화. 앱의 Application.onCreate()에서 초기화하는 것을 권장합니다.

Parameters

platform

플랫폼 이름

userId

유저 ID. 비로그인 상태라면 YLS.generateRandomId로 임시 ID 생성 권장

logger

실질적인 로깅 객체. YLS.Logger의 서브 타입

-
- +
+

log

-
fun log(vararg events: Pair<String, Any>)

기본적인 로그 메서드입니다.

YLS.log("event" to "click", "screen" to "mypage")

Parameters

events

이벤트 key-value 쌍

+
fun log(vararg events: Pair<String, Any>)

기본적인 로그 메서드입니다.

YLS.log("event" to "click", "screen" to "mypage")

Parameters

events

이벤트 key-value 쌍


fun log(eventData: YLSEventData)