chore: rename base classes, comments, formatting

This commit is contained in:
ksenia312
2024-02-05 13:25:36 +01:00
parent 4c2360bb27
commit 258cdf0adc
18 changed files with 103 additions and 96 deletions
+3
View File
@@ -25,6 +25,9 @@ class ReceivedNearbyFilesPack implements NearbyReceivedInterface {
@override
final NearbyDeviceInfo sender;
///
/// Received list of [NearbyFileInfo].
///
final List<NearbyFileInfo> files;
Map<String, dynamic> toJson() {
+5 -5
View File
@@ -3,8 +3,8 @@ import 'package:nearby_service/nearby_service.dart';
///
/// The message that will be sent from the current device.
///
final class OutgoingNearbyMessage<C extends NearbyMessageContentBase>
extends NearbyMessageBase<C> implements NearbyOutgoingInterface {
final class OutgoingNearbyMessage<C extends NearbyMessageContent>
extends NearbyMessage<C> implements NearbyOutgoingInterface {
///
/// To send a message, in addition to [content], you need to pass [receiver]
/// to know to whom the message is addressed.
@@ -50,8 +50,8 @@ final class OutgoingNearbyMessage<C extends NearbyMessageContentBase>
///
/// Message received by the current device.
///
final class ReceivedNearbyMessage<C extends NearbyMessageContentBase>
extends NearbyMessageBase<C> implements NearbyReceivedInterface {
final class ReceivedNearbyMessage<C extends NearbyMessageContent>
extends NearbyMessage<C> implements NearbyReceivedInterface {
///
/// The received message contains a [sender] in addition to [content],
/// to know from whom the message came.
@@ -66,7 +66,7 @@ final class ReceivedNearbyMessage<C extends NearbyMessageContentBase>
///
factory ReceivedNearbyMessage.fromJson(Map<String, dynamic>? json) {
return ReceivedNearbyMessage(
content: NearbyMessageContentBase.fromJson(json?['content']),
content: NearbyMessageContent.fromJson(json?['content']),
sender: NearbyDeviceInfo.fromJson(json?['sender']),
);
}
+12 -21
View File
@@ -6,7 +6,7 @@ import 'package:nearby_service/src/utils/random.dart';
///
/// Contains [value] - the message to be sent or received.
///
final class NearbyMessageTextContent extends NearbyMessageContentBase {
final class NearbyMessageTextContent extends NearbyMessageContent {
const NearbyMessageTextContent({required this.value});
///
@@ -23,9 +23,6 @@ final class NearbyMessageTextContent extends NearbyMessageContentBase {
///
final String value;
@override
NearbyMessageContentType get type => NearbyMessageContentType.text;
@override
bool get isValid => value.isNotEmpty;
@@ -56,13 +53,12 @@ final class NearbyMessageTextContent extends NearbyMessageContentBase {
///
/// Sealed class for files content in NearbyMessage.
///
sealed class NearbyMessageFilesContent extends NearbyMessageContentBase {
sealed class NearbyMessageFilesContent extends NearbyMessageContent {
///
/// Here [type] = [NearbyMessageContentType.filesResponse] or
/// [type] = [NearbyMessageContentType.filesRequest]
/// Here type is [NearbyMessageContentType.filesResponse] or
/// [NearbyMessageContentType.filesRequest]
///
/// Also [NearbyMessageFilesContent] contains [id] of the files pack and
/// list of [NearbyFileInfo] to determine the files.
/// Also [NearbyMessageFilesContent] contains [id] of the files pack.
///
const NearbyMessageFilesContent({required this.id});
@@ -103,6 +99,9 @@ sealed class NearbyMessageFilesContent extends NearbyMessageContentBase {
/// Contains info about the [files].
///
final class NearbyMessageFilesRequest extends NearbyMessageFilesContent {
///
/// Adds a [NearbyFileInfo] list to [id] to identify files.
///
const NearbyMessageFilesRequest._({
required super.id,
required this.files,
@@ -110,8 +109,9 @@ final class NearbyMessageFilesRequest extends NearbyMessageFilesContent {
///
/// Basic constructor with [files] to be sent or received.
/// Generates [id] in constructor.
///
NearbyMessageFilesRequest({required this.files})
NearbyMessageFilesRequest.create({required this.files})
: super(
id: RandomUtils.instance.nextInt(1000000, 9999999).toString(),
);
@@ -135,9 +135,6 @@ final class NearbyMessageFilesRequest extends NearbyMessageFilesContent {
///
final List<NearbyFileInfo> files;
@override
NearbyMessageContentType get type => NearbyMessageContentType.filesRequest;
@override
String toString() {
return 'NearbyMessageFileRequest{id: $id, files: $files}';
@@ -157,9 +154,7 @@ final class NearbyMessageFilesRequest extends NearbyMessageFilesContent {
bool get isValid =>
super.isValid &&
files.isNotEmpty &&
files.every(
(element) => element.path.isNotEmpty,
);
files.every((element) => element.path.isNotEmpty);
@override
bool operator ==(Object other) =>
@@ -175,12 +170,11 @@ final class NearbyMessageFilesRequest extends NearbyMessageFilesContent {
///
/// Nearby message File Response. Used for file sending responses.
/// Does not contain files' bytes!
///
final class NearbyMessageFilesResponse extends NearbyMessageFilesContent {
///
/// Used to send a response to a previously received request.
/// Provide [id] from [NearbyMessageFilesRequest] or
/// Provide [id] from [NearbyMessageFilesRequest].
///
NearbyMessageFilesResponse({
required super.id,
@@ -202,9 +196,6 @@ final class NearbyMessageFilesResponse extends NearbyMessageFilesContent {
///
final bool response;
@override
NearbyMessageContentType get type => NearbyMessageContentType.filesResponse;
@override
Map<String, dynamic> toJson() {
return {