API রেফারেন্স

আপলোড

HTTP দিয়ে ফাইল বা খণ্ড আপলোড করুন, প্রাপ্ত খণ্ড দেখুন, ফাইল বা সংযুক্তিতে একত্র করুন এবং আপলোড কাজের অবস্থা দেখুন বা পরিষ্কার করুন।

টাইপ ডেফিনিশন

graphql
type Subscription {
  uploadMergeResult: UploadMergeResult!
}

type Mutation {
  deleteChunks(fileId: String!): Boolean!
  mergeChunks(fileId: String!, totalChunks: Int!, path: String!, replace: Boolean!, totalSize: Long!): MergeTask!
}

type Query {
  mergeStatus(fileId: String!): MergeTask!
  uploadedChunks(fileId: String!): [UploadedChunk!]!
}

scalar Long

type MergeTask {
	status: MergeTaskStatus!
	value: String
	mergedSize: Long
	error: String
}

enum MergeTaskStatus {
	NONE
	STARTED
	MERGING
	DONE
	FAILED
}

type UploadMergeResult {
	fileId: ID!
	ok: Boolean!
	value: String
	mergedSize: Long
	error: String
}

type UploadedChunk {
	index: Int!
	sizeBytes: Long!
}

অপারেশন

http

POST /upload

info-তে POST /upload-এর জন্য এনক্রিপ্ট করা রিকোয়েস্ট এনভেলপের আসল বাইট পাঠান, টেক্সট বা Base64 নয়। এটি file-এর আগে পাঠাতে হবে। সফল হলে HTTP 201 এবং প্লেইন টেক্সটে আসলে সংরক্ষিত ফাইলের নাম ফেরত আসে।

bash
curl 'https://<device-host>:<https-port>/upload' \
  -H 'c-id: <client-id>' \
  -F 'info=<./encrypted-info.bin' -F 'file=@./example.txt'
# Send info before file. Metadata JSON: { dir, replace, isAppFile, size }
# info contains raw encrypted request-envelope bytes for POST /upload.
# A Bearer header alone does not authenticate multipart uploads.
http

POST /upload_chunk

POST /upload_chunk-এর জন্য info-র এনক্রিপ্ট করা আসল বাইট file-এর আগে পাঠান। সফল হলে HTTP 201 এবং প্লেইন টেক্সটে index:size ফেরত আসে। uploadedChunks দেখুন, তারপর mergeChunks বা mergeAppFileChunks কল করে mergeStatus দিয়ে অবস্থা দেখুন।

bash
curl 'https://<device-host>:<https-port>/upload_chunk' \
  -H 'c-id: <client-id>' \
  -F 'info=<./encrypted-info.bin' -F 'file=@./chunk.bin'
# Metadata JSON: { fileId, index, size }; bind encryption to POST /upload_chunk.
# Inspect uploadedChunks; call mergeChunks with totalSize for normal files,
# or mergeAppFileChunks for app attachments. Poll mergeStatus for completion.
subscription

uploadMergeResult

অ্যাসিঙ্ক্রোনাস আপলোড খণ্ড একত্রীকরণের সম্পূর্ণ বা ব্যর্থ হওয়ার তথ্য পায়।

graphql
subscription uploadMergeResult {
  uploadMergeResult { fileId ok value mergedSize error }
}
mutation

deleteChunks

খণ্ডভিত্তিক আপলোডের fileId-এর সব সংরক্ষিত খণ্ড মুছে দেয়। বাতিল বা ব্যর্থ আপলোডের পরে ডিস্ক খালি করতে ব্যবহার করুন।

graphql
mutation deleteChunks($fileId: String!) {
  deleteChunks(fileId: $fileId)
}
mutation

mergeChunks

আপলোড করা খণ্ডকে গন্তব্য ফাইলে একত্রীকরণ শুরু করে; সম্পূর্ণ হওয়া দেখতে mergeStatus দেখুন।

graphql
# Starts the merge and returns immediately; completion arrives over the
# websocket, and `mergeStatus` is the polling fallback for a lost event.
mutation mergeChunks($fileId: String!, $totalChunks: Int!, $path: String!, $replace: Boolean!, $totalSize: Long!) {
  mergeChunks(fileId: $fileId, totalChunks: $totalChunks, path: $path, replace: $replace, totalSize: $totalSize) { status value mergedSize error }
}
query

mergeStatus

আপলোড একত্রীকরণের অগ্রগতি বা ব্যর্থতা পড়ে; NONE অবস্থা মানে এই ফাইল ID-র একত্রীকরণ শুরু হয়নি।

graphql
# `NONE` when no merge was ever started for this id, which is what a
# client sees before it calls `mergeChunks`.
query mergeStatus($fileId: String!) {
  mergeStatus(fileId: $fileId) { status value mergedSize error }
}
query

uploadedChunks

পুনরায় চালানো যায় এমন খণ্ডভিত্তিক আপলোডের ইতিমধ্যে পাওয়া খণ্ড সূচক তালিকাভুক্ত করে। থেমে যাওয়া আপলোড আবার চালাতে ব্যবহৃত হয়।

graphql
query uploadedChunks($fileId: String!) {
  uploadedChunks(fileId: $fileId) { index sizeBytes }
}