Skip to content

Commit a296809

Browse files
AsamKmoxie0
authored andcommitted
Update README, API changes
Adapt sample code to changes in the API Fix typo Closes signalapp#6 // FREEBIE
1 parent bf4c940 commit a296809

File tree

1 file changed

+44
-39
lines changed

1 file changed

+44
-39
lines changed

README.md

+44-39
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ of your key and session information to durable media.
1010

1111
## Creating keys
1212

13-
`````
13+
`````java
1414
IdentityKeyPair identityKey = KeyHelper.generateIdentityKeyPair();
15-
List<PreKeyRecord> oneTimePreKeys = KeyHelper.generatePreKeys(100);
15+
List<PreKeyRecord> oneTimePreKeys = KeyHelper.generatePreKeys(0, 100);
16+
PreKeyRecord lastResortKey = KeyHelper.generateLastResortPreKey();
1617
SignedPreKeyRecord signedPreKeyRecord = KeyHelper.generateSignedPreKey(identityKey, signedPreKeyId);
1718
`````
1819

@@ -22,78 +23,82 @@ The above are then stored locally so that they're available for load via the `Si
2223

2324
At install time, clients need to register with the Signal server.
2425

25-
`````
26+
`````java
2627
private final String URL = "https://my.signal.server.com";
2728
private final TrustStore TRUST_STORE = new MyTrustStoreImpl();
2829
private final String USERNAME = "+14151231234";
2930
private final String PASSWORD = generateRandomPassword();
31+
private final String USER_AGENT = "[FILL_IN]";
3032

3133
SignalServiceAccountManager accountManager = new SignalServiceAccountManager(URL, TRUST_STORE,
32-
USERNAME, PASSWORD);
34+
USERNAME, PASSWORD, USER_AGENT);
3335

3436
accountManager.requestSmsVerificationCode();
35-
accountManager.verifyAccount(receivedSmsVerificationCode, generateRandomSignalingKey(),
36-
false, generateRandomInstallId());
37+
accountManager.verifyAccountWithCode(receivedSmsVerificationCode, generateRandomSignalingKey(),
38+
generateRandomInstallId(), false);
3739
accountManager.setGcmId(Optional.of(GoogleCloudMessaging.getInstance(this).register(REGISTRATION_ID)));
38-
accountManager.setPreKeys(identityKey.getPublic(), lastResortKey, signedPreKey, oneTimePreKeys);
40+
accountManager.setPreKeys(identityKey.getPublicKey(), lastResortKey, signedPreKeyRecord, oneTimePreKeys);
3941
`````
4042

4143
## Sending text messages
4244

43-
`````
45+
`````java
4446
SignalServiceMessageSender messageSender = new SignalServiceMessageSender(URL, TRUST_STORE, USERNAME, PASSWORD,
45-
localRecipientId, new MySignalProtocolStore(),
46-
Optional.absent());
47+
new MySignalProtocolStore(),
48+
USER_AGENT, Optional.absent());
4749

48-
messageSender.sendMessage(new SignalProtocolAddress("+14159998888"),
49-
SignalProtocolMessage.newBuilder()
50-
.withBody("Hello, world!")
51-
.build());
50+
messageSender.sendMessage(new SignalServiceAddress("+14159998888"),
51+
SignalServiceDataMessage.newBuilder()
52+
.withBody("Hello, world!")
53+
.build());
5254
`````
5355

5456
## Sending media messages
5557

56-
`````
58+
`````java
5759
SignalServiceMessageSender messageSender = new SignalServiceMessageSender(URL, TRUST_STORE, USERNAME, PASSWORD,
58-
localRecipientId, new MySignalProtocolStore(),
59-
Optional.absent());
60-
61-
File myAttachment = new File("/path/to/my.attachment");
62-
FileInputStream attachmentStream = new FileInputStream(myAttachment);
63-
TextSecureAttachment attachment = SignalServiceAttachment.newStreamBuilder()
64-
.withStream(attachmentStream)
65-
.withContentType("image/png")
66-
.withLength(myAttachment.size())
67-
.build();
68-
69-
messageSender.sendMessage(new SignalProtocolAddress("+14159998888"),
70-
SignalProtocolMessage.newBuilder()
71-
.withBody("An attachment!")
72-
.withAttachment(attachment)
73-
.build());
60+
new MySignalProtocolStore(),
61+
USER_AGENT, Optional.absent());
62+
63+
File myAttachment = new File("/path/to/my.attachment");
64+
FileInputStream attachmentStream = new FileInputStream(myAttachment);
65+
SignalServiceAttachment attachment = SignalServiceAttachment.newStreamBuilder()
66+
.withStream(attachmentStream)
67+
.withContentType("image/png")
68+
.withLength(myAttachment.length())
69+
.build();
70+
71+
messageSender.sendMessage(new SignalServiceAddress("+14159998888"),
72+
SignalServiceDataMessage.newBuilder()
73+
.withBody("An attachment!")
74+
.withAttachment(attachment)
75+
.build());
7476

7577
`````
7678

7779
## Receiving messages
7880

79-
`````
80-
SignalServiceMessageReceiver messageReceiver = new SignalServiceMessageReceiver(URL, TRUST_STORE, USERNAME, PASSWORD, mySignalingKey);
81-
SignalServiceMessagePipe messagePipe;
81+
`````java
82+
SignalServiceMessageReceiver messageReceiver = new SignalServiceMessageReceiver(URL, TRUST_STORE, USERNAME,
83+
PASSWORD, mySignalingKey,
84+
USER_AGENT);
85+
SignalServiceMessagePipe messagePipe = null;
8286

8387
try {
84-
messagePipe = messageReciever.createMessagePipe();
88+
messagePipe = messageReceiver.createMessagePipe();
8589

8690
while (listeningForMessages) {
8791
SignalServiceEnvelope envelope = messagePipe.read(timeout, timeoutTimeUnit);
88-
SignalServiceCipher cipher = new SignalServiceCipher(new MySignalProtocolStore());
89-
SignalServiceMessage message = cipher.decrypt(envelope);
92+
SignalServiceCipher cipher = new SignalServiceCipher(new SignalServiceAddress(USERNAME),
93+
new MySignalProtocolStore());
94+
SignalServiceContent message = cipher.decrypt(envelope);
9095

91-
System.out.println("Received message: " + message.getBody().get());
96+
System.out.println("Received message: " + message.getDataMessage().get().getBody().get());
9297
}
9398

9499
} finally {
95100
if (messagePipe != null)
96-
messagePipe.close();
101+
messagePipe.shutdown();
97102
}
98103
`````
99104

0 commit comments

Comments
 (0)